New format of documentation #369
Conversation
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes. Files selected but had no reviewable changes (1)
You can disable this status message by setting the WalkthroughThis update significantly enhances the documentation and configuration capabilities of the Panther robot system. It introduces a comprehensive set of launch arguments, a new Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant System
participant Documentation
User->>System: Request for configuration details
System->>Documentation: Retrieve updated materials
Documentation-->>System: Provide structured and enhanced documentation
System-->>User: Deliver user-friendly guidance and configuration instructions
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 15
Outside diff range, codebase verification and nitpick comments (10)
panther_controller/CONFIGURATION.md (1)
9-9: Enhance clarity by specifying the launch argument.Specify that the
wheel_typelaunch argument can be set to one of the three supported types.- By default, three types of wheels are supported using the launch argument `wheel_type`. + By default, three types of wheels are supported using the launch argument `wheel_type`, which can be set to one of the supported types.panther_description/README.md (1)
31-31: Consider using stronger wording.The phrase "If you want to learn" can be strengthened for better readability.
- If you want to learn how to configure individual nodes, please check the appropriate package. + To learn how to configure individual nodes, please check the appropriate package.Tools
LanguageTool
[style] ~31-~31: Consider using an alternative to strengthen your wording.
Context: ...ackage only runs external nodes. If you want to learn how to configure individual no...(WANT_KEEN)
panther_bringup/README.md (2)
30-30: Consider using a hyphen for the compound adjective.If this is a compound adjective that modifies the following noun, use a hyphen.
- user defined animations + user-defined animationsTools
LanguageTool
[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:None...(EN_COMPOUND_ADJECTIVE_INTERNAL)
54-54: Consider using an alternative to strengthen your wording.The phrase "want to" can be replaced with a stronger alternative.
- If you want to learn how to configure individual nodes + If you wish to learn how to configure individual nodesTools
LanguageTool
[style] ~54-~54: Consider using an alternative to strengthen your wording.
Context: ...ackage only runs external nodes. If you want to learn how to configure individual no...(WANT_KEEN)
panther_hardware_interfaces/README.md (3)
10-10: Consider adding a comma.It seems that a comma is missing after "To use this hardware interface".
- To use this hardware interface you have to add it to your URDF + To use this hardware interface, you have to add it to your URDFTools
LanguageTool
[typographical] ~10-~10: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~10-~10: Use a comma after introducing a concessive statement.
Context: ...ree/ros2/panther_controller/) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
10-10: Consider adding a comma after the concessive statement.Use a comma after introducing a concessive statement.
- That said apart from the usual interface provided by the ros2_control + That said, apart from the usual interface provided by the ros2_controlTools
LanguageTool
[typographical] ~10-~10: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~10-~10: Use a comma after introducing a concessive statement.
Context: ...ree/ros2/panther_controller/) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
65-65: Consider adding a comma.It seems that a comma is missing after "To use this hardware interface".
- To use this hardware interface you have to add it to your URDF + To use this hardware interface, you have to add it to your URDFTools
LanguageTool
[typographical] ~65-~65: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
panther_manager/CONFIGURATION.md (1)
152-152: Consider a shorter alternative.‘Taken into account’ might be wordy. Consider a shorter alternative.
- the one with the higher temperature is taken into account + the one with the higher temperature is consideredTools
LanguageTool
[style] ~152-~152: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ... the one with the higher temperature is taken into account. -e_stop_state[bool, default: **N...(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)
ROS_API.md (2)
5-5: Consider rephrasing for conciseness.Consider replacing "in a significant way" with "significantly" to avoid wordiness.
- It is functional and architecture will not change in a significant way. + It is functional and architecture will not change significantly.Tools
LanguageTool
[style] ~5-~5: Consider replacing this phrase with the adverb “significantly” to avoid wordiness.
Context: ...tional and architecture will not change in a significant way. It was tested by Husarion team, howeve...(IN_A_X_MANNER)
23-23: Consider rephrasing for conciseness.Consider removing "of" to be more concise.
- All of the drivers were written in ROS 2 framework. + All the drivers were written in ROS 2 framework.Tools
LanguageTool
[style] ~23-~23: Consider removing “of” to be more concise
Context: ...s via the Robot Operating System (ROS). All of the drivers were written in ROS 2 framework...(ALL_OF_THE)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (20)
- .pre-commit-config.yaml (1 hunks)
- ROS_API.md (1 hunks)
- panther_battery/README.md (2 hunks)
- panther_bringup/CMakeLists.txt (1 hunks)
- panther_bringup/README.md (1 hunks)
- panther_controller/CONFIGURATION.md (1 hunks)
- panther_controller/README.md (1 hunks)
- panther_controller/launch/controller.launch.py (2 hunks)
- panther_description/README.md (1 hunks)
- panther_description/launch/load_urdf.launch.py (2 hunks)
- panther_diagnostics/README.md (1 hunks)
- panther_gazebo/CONFIGURATION.md (1 hunks)
- panther_gazebo/README.md (1 hunks)
- panther_hardware_interfaces/README.md (5 hunks)
- panther_lights/CONFIGURATION.md (1 hunks)
- panther_lights/README.md (1 hunks)
- panther_localization/README.md (2 hunks)
- panther_manager/CONFIGURATION.md (1 hunks)
- panther_manager/README.md (3 hunks)
- panther_manager/launch/manager_bt.launch.py (1 hunks)
Files skipped from review due to trivial changes (4)
- .pre-commit-config.yaml
- panther_controller/launch/controller.launch.py
- panther_description/launch/load_urdf.launch.py
- panther_lights/README.md
Additional context used
LanguageTool
panther_controller/CONFIGURATION.md
[uncategorized] ~5-~5: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ocity Smoothing Parameters The Panther use [diff_drive_controller](https://control...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
panther_diagnostics/README.md
[style] ~25-~25: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
panther_battery/README.md
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...e*](.) | ## ROS Nodes -battery_node: Publishes battery state read from ADC u...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/CONFIGURATION.md
[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ...g). > [!NOTE] > > The battery model is quite simple and involves significant simplification...(EN_WEAK_ADJECTIVE)
panther_description/README.md
[style] ~13-~13: To form a complete sentence, be sure to include a subject.
Context: ...h information about the wheel position. Should be false when there is a controller tha...(MISSING_IT_THERE)
[style] ~31-~31: Consider using an alternative to strengthen your wording.
Context: ...ackage only runs external nodes. If you want to learn how to configure individual no...(WANT_KEEN)
panther_localization/README.md
[grammar] ~16-~16: The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’).
Context: ...localization_config_path| string: depends | Path to the EKF config...(DEPEND_ON)
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...os2) | ## Running Nodes -ekf_filter: The Extended Kalman Filter node is desi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ders, IMU, and GPS. -navsat_transform: It converts raw GPS data into odometry ...(UNLIKELY_OPENING_PUNCTUATION)
panther_controller/README.md
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... | ## ROS Nodes -ros2_control_node: Controller Manager performs two main fu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...U sensors. -joint_state_broadcaster: The broadcaster reads all state interfa...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~37-~37: Loose punctuation mark.
Context: ... specific topics. -drive_controller: Controller which manages mobile robots ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: Loose punctuation mark.
Context: ...and shares it. -robot_state_publisher: The Robot State Publisher broadcasts a ...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/README.md
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ...configuration file.
string:LocalVar('FindPackageShare(pkg='panther_localization') + 'config' + PythonExpr(''' + PythonExpr(''' + LaunchConfig('localization_mode') + '_'') + 'localization' + PythonExpr(''_with_gps' if ' + LaunchConfig('fuse_gps') + ' else ''') + '.yaml'')) ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:''...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_lights/CONFIGURATION.md
[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...ween multiple panels. -number_of_leds: defines the total number of LEDs presen...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~30-~30: Loose punctuation mark.
Context: ... segment has three attributes: -name: the identifier for the segment, such as...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...e between multiple segments. -channel: This specifies which LED panel the segm...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~31-~31: After ‘It’, use the third-person verb form “has”.
Context: ...ch LED panel the segment belongs to. It have to match one of the channels defined in...(IT_VBZ)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...d in thepanelssection. -led_range: This defines the range of LEDs within t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Did you mean: “By default,”?
Context: ...ents defined in thesegmentssection. By default you can use provided mapping: -all...(BY_DEFAULT_COMMA)
[uncategorized] ~69-~69: Possible missing comma found.
Context: ...s]**. If animation fails to fulfill the requirement it will result in an error. #### Image...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~150-~150: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 6806 characters long)
Context: ...are reserved for system animations. > [!NOTE] > Priority 1 is reserved for c...(EN_EXCESSIVE_EXCLAMATION)
panther_bringup/README.md
[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:None...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~54-~54: Consider using an alternative to strengthen your wording.
Context: ...ackage only runs external nodes. If you want to learn how to configure individual no...(WANT_KEEN)
panther_hardware_interfaces/README.md
[typographical] ~10-~10: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~10-~10: Use a comma after introducing a concessive statement.
Context: ...ree/ros2/panther_controller/) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
[typographical] ~65-~65: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
panther_manager/CONFIGURATION.md
[grammar] ~24-~24: The word ‘shutdown’ is a noun. Did you mean the verb “shut down”?
Context: ...known_hosts** of a computer you want to shutdown automatically: ``` bash ssh-copy-id us...(SHUTDOWN)
[grammar] ~78-~78: The word “shutdown” is a noun. The verb is spelled with a space.
Context: .... -ShutdownHostsFromFile- allows to shutdown devices based on a YAML file. Returns `...(NOUN_VERB_CONFUSION)
[misspelling] ~78-~78: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ost. This allows some hosts to wait for a SSH response, while others are already ...(EN_A_VS_AN)
[uncategorized] ~78-~78: Possible missing comma found.
Context: ... awaiting a full shutdown. If a host is shutdown it is no longer processed. In the case ...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~80-~80: The word “shutdown” is a noun. The verb is spelled with a space.
Context: ...own. -ShutdownSingleHost- allows to shutdown a single device. Will returnSUCCESS...(NOUN_VERB_CONFUSION)
[style] ~152-~152: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ... the one with the higher temperature is taken into account. -e_stop_state[bool, default: **N...(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)
ROS_API.md
[style] ~5-~5: Consider replacing this phrase with the adverb “significantly” to avoid wordiness.
Context: ...tional and architecture will not change in a significant way. It was tested by Husarion team, howeve...(IN_A_X_MANNER)
[style] ~23-~23: Consider removing “of” to be more concise
Context: ...s via the Robot Operating System (ROS). All of the drivers were written in ROS 2 framework...(ALL_OF_THE)
Markdownlint
panther_lights/CONFIGURATION.md
149-149: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
panther_manager/CONFIGURATION.md
103-103: null
Images should have alternate text (alt text)(MD045, no-alt-text)
144-144: null
Images should have alternate text (alt text)(MD045, no-alt-text)
180-180: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (46)
panther_bringup/CMakeLists.txt (1)
6-6: Verify the removal of theconfigdirectory from the installation path.The change removes the
configdirectory from the installation path. Ensure that this change aligns with the project's structure and that theconfigdirectory is no longer required in the installation path.Verification successful
The removal of the
configdirectory from thepanther_bringupmodule's installation path is verified.There are no references to the
configdirectory within thepanther_bringupmodule, indicating that it is not required for this specific module. The change aligns with the project's structure.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify if the `config` directory is no longer required in the installation path. # Test: Search for references to the `config` directory in the project's CMakeLists.txt files. rg --type cmake 'config'Length of output: 1352
Script:
#!/bin/bash # Description: Verify if the `config` directory is referenced within the panther_bringup module. # Test: Search for references to the `config` directory in the panther_bringup directory. rg --type cmake 'config' panther_bringupLength of output: 40
panther_battery/README.md (6)
3-3: Introduction refinement approved.The updated introduction is clear and effectively describes the package's purpose.
5-11: Launch Files section reorganization approved.The reorganization and new header improve the clarity and usability of the documentation.
13-15: Detailed arguments section approved.The table outlining the arguments accepted by
battery.launch.pyis clear and enhances usability.
17-21: Nodes section forbattery.launch.pyapproved.The table format provides a clear overview of the nodes activated by
battery.launch.py.
23-25: ROS Nodes section update approved.The renaming from
battery_drivertobattery_nodealigns the documentation with the implementation updates.Tools
LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...e*](.) | ## ROS Nodes -battery_node: Publishes battery state read from ADC u...(UNLIKELY_OPENING_PUNCTUATION)
25-25: Skip: Loose punctuation mark.The flagged loose punctuation mark does not affect the readability or meaning of the documentation.
Tools
LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...e*](.) | ## ROS Nodes -battery_node: Publishes battery state read from ADC u...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/CONFIGURATION.md (5)
3-9: Use of GPS in Simulation section approved.The instructions are clear and provide necessary details for configuring GPS in simulation.
11-19: Adding ANT02 tocomponents.yamlsection approved.The instructions are clear and provide necessary details for adding the ANT02 component.
21-31: Adding spherical coordinates to world's SDF file section approved.The instructions are clear and provide necessary details for adding spherical coordinates.
34-45: Linear Battery Plugin section approved.The information is clear and provides necessary details for simulating battery operation.
Tools
LanguageTool
[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ...g). > [!NOTE] > > The battery model is quite simple and involves significant simplification...(EN_WEAK_ADJECTIVE)
47-61: Charging Process section approved.The instructions are clear and provide necessary details for managing the charging process in simulation.
panther_manager/launch/manager_bt.launch.py (1)
66-69: Configuration source change approved.The change in the configuration source for the shutdown hosts is approved.
However, verify that the new path is correct and that the necessary resources are available in the
panther_managerpackage.Verification successful
Verification successful.
The
shutdown_hosts.yamlfile exists in thepanther_manager/configdirectory, confirming that the new configuration source is correct and the necessary resources are available.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the new path and resources in the `panther_manager` package. # Test: Search for the shutdown_hosts.yaml file in the `panther_manager` package. Expect: The file exists in the specified path. fd shutdown_hosts.yaml --search-path "$(fd panther_manager | head -n 1)/config"Length of output: 141
panther_description/README.md (1)
24-27: LGTM!The table listing the nodes involved in
load_urdf.launch.pyis well-structured and clear.panther_localization/README.md (4)
21-24: LGTM!The table listing the nodes involved in
localization.launch.pyis well-structured and clear.
31-33: LGTM!The configuration details for
ekf_filterare clear and provide useful links for further information.
54-56: LGTM!The configuration details for
navsat_transformare clear and provide useful links for further information.
28-29: Fix punctuation issues.There are loose punctuation marks in the descriptions of
ekf_filterandnavsat_transform.- - `ekf_filter`: The Extended Kalman Filter node is designed to fuse odometry data from various sources, including wheel encoders, IMU, and GPS. - - `navsat_transform`: It converts raw GPS data into odometry data and publishes corrected GPS positions based on sensor data at a higher frequency. + - `ekf_filter`: The Extended Kalman Filter node is designed to fuse odometry data from various sources, including wheel encoders, IMU, and GPS. + - `navsat_transform` converts raw GPS data into odometry data and publishes corrected GPS positions based on sensor data at a higher frequency.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~28-~28: Loose punctuation mark.
Context: ...os2) | ## Running Nodes -ekf_filter: The Extended Kalman Filter node is desi...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~29-~29: Loose punctuation mark.
Context: ...ders, IMU, and GPS. -navsat_transform: It converts raw GPS data into odometry ...(UNLIKELY_OPENING_PUNCTUATION)
panther_controller/README.md (4)
11-20: LGTM!The table listing the arguments for
controller.launch.pyis well-structured and clear.
24-30: LGTM!The table listing the nodes involved in
controller.launch.pyis well-structured and clear.
34-36: LGTM!The description of the
imu_broadcasterpublishers is clear and provides useful information.Tools
LanguageTool
[uncategorized] ~34-~34: Loose punctuation mark.
Context: ... | ## ROS Nodes -ros2_control_node: Controller Manager performs two main fu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: Loose punctuation mark.
Context: ...U sensors. -joint_state_broadcaster: The broadcaster reads all state interfa...(UNLIKELY_OPENING_PUNCTUATION)
64-68: LGTM!The description of the
robot_state_publisherpublishers is clear and provides useful information.panther_manager/README.md (3)
5-19: Well-structured documentation for launch file arguments.The new section for
manager_bt.launch.pyand its arguments is clear and well-organized.
21-26: Clear documentation for launch file nodes.The new section for nodes related to
manager_bt.launch.pyis concise and clear.
Line range hint
28-57: Comprehensive documentation for ROS nodes.The section provides detailed and well-organized information about the
lights_managerandsafety_managernodes.Tools
LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...s responsible for high-level control of Husarion Panther robot. ## Launch Files This p...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
panther_gazebo/README.md (2)
5-27: Well-structured documentation for launch file arguments.The new section for
spawn_robotlaunch arguments is clear and well-organized.Tools
LanguageTool
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ...configuration file.
string:LocalVar('FindPackageShare(pkg='panther_localization') + 'config' + PythonExpr(''' + PythonExpr(''' + LaunchConfig('localization_mode') + '_'') + 'localization' + PythonExpr(''_with_gps' if ' + LaunchConfig('fuse_gps') + ' else ''') + '.yaml'')) ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:''...(EN_COMPOUND_ADJECTIVE_INTERNAL)
12-27: Well-structured documentation for spawn_robot launch arguments.The new section for
spawn_robotlaunch arguments is clear and well-organized.Tools
LanguageTool
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ...configuration file.
string:LocalVar('FindPackageShare(pkg='panther_localization') + 'config' + PythonExpr(''' + PythonExpr(''' + LaunchConfig('localization_mode') + '_'') + 'localization' + PythonExpr(''_with_gps' if ' + LaunchConfig('fuse_gps') + ' else ''') + '.yaml'')) ...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~26-~26: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:''...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_lights/CONFIGURATION.md (6)
3-18: Clear and well-structured documentation for LED animations.The section provides a comprehensive overview of the LED animations configuration.
19-25: Clear and well-structured documentation for LED panels.The section provides detailed information about the LED panels configuration.
Tools
LanguageTool
[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...ween multiple panels. -number_of_leds: defines the total number of LEDs presen...(UNLIKELY_OPENING_PUNCTUATION)
26-33: Clear and well-structured documentation for LED segments.The section provides detailed information about the LED segments configuration.
Tools
LanguageTool
[uncategorized] ~30-~30: Loose punctuation mark.
Context: ... segment has three attributes: -name: the identifier for the segment, such as...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...e between multiple segments. -channel: This specifies which LED panel the segm...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~31-~31: After ‘It’, use the third-person verb form “has”.
Context: ...ch LED panel the segment belongs to. It have to match one of the channels defined in...(IT_VBZ)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...d in thepanelssection. -led_range: This defines the range of LEDs within t...(UNLIKELY_OPENING_PUNCTUATION)
34-41: Clear and well-structured documentation for segments map.The section provides detailed information about the segments map configuration.
Tools
LanguageTool
[uncategorized] ~36-~36: Did you mean: “By default,”?
Context: ...ents defined in thesegmentssection. By default you can use provided mapping: -all...(BY_DEFAULT_COMMA)
42-57: Clear and well-structured documentation for LED animations.The section provides detailed information about the LED animations configuration.
58-145: Clear and well-structured documentation for animation types.The section provides detailed information about the different types of LED animations.
Tools
LanguageTool
[uncategorized] ~69-~69: Possible missing comma found.
Context: ...s]**. If animation fails to fulfill the requirement it will result in an error. #### Image...(AI_HYDRA_LEO_MISSING_COMMA)
panther_bringup/README.md (3)
34-51: LGTM!The simplification of the section listing nodes and linking to their respective packages reduces redundancy and improves accessibility.
52-54: LGTM!The section is concise and directs users to the appropriate package for configuration details.
Tools
LanguageTool
[style] ~54-~54: Consider using an alternative to strengthen your wording.
Context: ...ackage only runs external nodes. If you want to learn how to configure individual no...(WANT_KEEN)
5-33: LGTM! Verify the correctness of new arguments.The table format for listing launch file arguments enhances clarity. The descriptions are detailed and provide default values.
However, ensure that the new arguments
fuse_gpsandlights_bt_project_pathare correctly implemented in the launch files.Verification successful
Let's update the script to search for the arguments in all files, ensuring we capture any occurrences in the launch files.
The new arguments
fuse_gpsandlights_bt_project_pathare correctly implemented in the launch files.
fuse_gpsis found inpanther_localization/launch/localization.launch.py.lights_bt_project_pathis found inpanther_manager/launch/manager_bt.launch.py.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of new arguments in the launch files. # Test: Search for the new arguments. Expect: Occurrences of the new arguments in the launch files. rg --type python 'fuse_gps|lights_bt_project_path'Length of output: 83
Script:
#!/bin/bash # Description: Verify the implementation of new arguments in the launch files. # Test: Search for the new arguments. Expect: Occurrences of the new arguments in the launch files. rg 'fuse_gps|lights_bt_project_path'Length of output: 4617
Tools
LanguageTool
[uncategorized] ~30-~30: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:None...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_hardware_interfaces/README.md (3)
10-10: LGTM!The updates to URLs and descriptions ensure that users are directed to the correct version of the documentation and resources.
Tools
LanguageTool
[typographical] ~10-~10: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
[formatting] ~10-~10: Use a comma after introducing a concessive statement.
Context: ...ree/ros2/panther_controller/) package). That said apart from the usual interface provided...(EVEN_SO_PREMIUM)
Line range hint
33-48:
LGTM!The updates to relative paths enhance the document's usability within the context of the project structure.
65-69: LGTM!The updates to URLs and descriptions ensure that users are directed to the correct version of the documentation and resources.
Tools
LanguageTool
[typographical] ~65-~65: It seems that a comma is missing.
Context: ... resource manager. To use this hardware interface you have to add it to your URDF (you ca...(IN_ORDER_TO_VB_COMMA)
panther_manager/CONFIGURATION.md (3)
3-21: LGTM!The section is detailed and provides clear instructions for setting up the shutdown behavior, including an example YAML file for shutdown hosts.
39-56: LGTM!The section is detailed and provides clear instructions for handling different power supply health states based on messages received on the
battery/battery_statustopic.
59-212: LGTM!The section is detailed and provides clear instructions for setting up and modifying BehaviorTree projects for lights handling, safety, and system shutdown.
Tools
LanguageTool
[grammar] ~78-~78: The word “shutdown” is a noun. The verb is spelled with a space.
Context: .... -ShutdownHostsFromFile- allows to shutdown devices based on a YAML file. Returns `...(NOUN_VERB_CONFUSION)
[misspelling] ~78-~78: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ost. This allows some hosts to wait for a SSH response, while others are already ...(EN_A_VS_AN)
[uncategorized] ~78-~78: Possible missing comma found.
Context: ... awaiting a full shutdown. If a host is shutdown it is no longer processed. In the case ...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~80-~80: The word “shutdown” is a noun. The verb is spelled with a space.
Context: ...own. -ShutdownSingleHost- allows to shutdown a single device. Will returnSUCCESS...(NOUN_VERB_CONFUSION)
[style] ~152-~152: ‘taken into account’ might be wordy. Consider a shorter alternative.
Context: ... the one with the higher temperature is taken into account. -e_stop_state[bool, default: **N...(EN_WORDINESS_PREMIUM_TAKEN_INTO_ACCOUNT)
Markdownlint
103-103: null
Images should have alternate text (alt text)(MD045, no-alt-text)
144-144: null
Images should have alternate text (alt text)(MD045, no-alt-text)
180-180: null
Images should have alternate text (alt text)(MD045, no-alt-text)
ROS_API.md (4)
29-32: LGTM!The section is clear and provides necessary information about the ROS interfaces.
39-64: LGTM!The section is detailed and provides comprehensive information about the topics available for the Panther robot.
65-72: LGTM!The section is clear and provides necessary information about the hidden topics available for the Panther robot.
73-98: LGTM!The section is detailed and provides comprehensive information about the services available for the Panther robot.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range, codebase verification and nitpick comments (13)
panther_diagnostics/README.md (1)
11-11: Fix the punctuation issue.The punctuation mark after the file name should be removed.
- [`system_status_parameters.yaml`](./config/system_status_parameters.yaml): defines parameters for `system_status_node`. + [`system_status_parameters.yaml`](./config/system_status_parameters.yaml) defines parameters for `system_status_node`.Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...(./config/system_status_parameters.yaml): defines parameters for `system_status_n...(UNLIKELY_OPENING_PUNCTUATION)
panther_description/README.md (1)
11-14: Fix the punctuation issues.The punctuation marks after the file names should be removed.
- [`components.yaml`](./config/components.yaml): allows you to quickly add visualization of sensors, TF connections and simulate their behavior in the simulator. + [`components.yaml`](./config/components.yaml) allows you to quickly add visualization of sensors, TF connections and simulate their behavior in the simulator. - [`WH01.yaml`](./config/WH01.yaml): description of physical and visual parameters for the wheel WH01. + [`WH01.yaml`](./config/WH01.yaml) describes the physical and visual parameters for the wheel WH01. - [`WH02.yaml`](./config/WH02.yaml): description of physical and visual parameters for the wheel WH02. + [`WH02.yaml`](./config/WH02.yaml) describes the physical and visual parameters for the wheel WH02. - [`WH04.yaml`](./config/WH04.yaml): description of physical and visual parameters for the wheel WH04. + [`WH04.yaml`](./config/WH04.yaml) describes the physical and visual parameters for the wheel WH04.Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
panther_lights/README.md (1)
11-13: Fix the punctuation issue.The punctuation mark after the file name should be removed.
- [`led_config.yaml`](./config/led_config.yaml): describe the appearance and parameters of the animation. + [`led_config.yaml`](./config/led_config.yaml) describes the appearance and parameters of the animation.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): describe the appearance and parameters ...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/README.md (2)
5-11: Clarify the description ofsimulate_robot.launch.py.The phrase "giving birth to the robot" is unconventional and might be confusing. Consider rephrasing it to "initializing the robot" or "starting the robot simulation."
- `simulate_robot.launch.py` - is responsible for giving birth to the robot and simulating its physical behavior, such as driving, displaying data, etc. + `simulate_robot.launch.py` - is responsible for initializing the robot and simulating its physical behavior, such as driving, displaying data, etc.
12-16: Fix punctuation in configuration file descriptions.The descriptions should start with a capital letter for consistency and clarity.
- [`battery_plugin_config.yaml`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configuration - [`gz_bridge.yaml`](./config/gz_bridge.yaml): specify data to exchange between ROS and Gazebo simulation. - [`led_strips.yaml`](./config/led_strips.yaml): configure properties of led strips in simulation to animate lights. + [`battery_plugin_config.yaml`](./config/battery_plugin_config.yaml): Simulated LinearBatteryPlugin configuration. + [`gz_bridge.yaml`](./config/gz_bridge.yaml): Specify data to exchange between ROS and Gazebo simulation. + [`led_strips.yaml`](./config/led_strips.yaml): Configure properties of LED strips in simulation to animate lights.Tools
LanguageTool
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...l`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configura...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ..._strips.yaml`](./config/led_strips.yaml): configure properties of led strips in s...(UNLIKELY_OPENING_PUNCTUATION)
panther_bringup/README.md (2)
5-9: Clarify the description ofbringup.launch.py.The description "activating whole robot system" can be made clearer.
- `bringup.launch.py` - is responsible for activating whole robot system. + `bringup.launch.py` - is responsible for activating the entire robot system.
28-29: Remove redundancy insystem_monitordescription.The phrase "RAM memory usage" is redundant. Use "RAM usage" instead.
- Publishes system state of the Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature. + Publishes system state of the Built-in Computer such as CPU usage, RAM usage, disk usage, and CPU temperature.Tools
LanguageTool
[style] ~29-~29: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
README.md (6)
69-75: Correct the preposition for clarity.The preposition "for" seems more appropriate than "in" in this context.
- | 🖥️ | Available in simulated robot | + | 🖥️ | Available for simulated robot |Tools
LanguageTool
[uncategorized] ~74-~74: The preposition ‘for’ seems more likely in this position.
Context: ...physical robot | | 🖥️ | Available in simulated robot | 'battery_config_...(AI_HYDRA_LEO_REPLACE_IN_FOR)
76-79: Use fenced code block style.For consistency, the code block style should be fenced rather than indented.
- 'battery_config_path': + ```yaml + 'battery_config_path': + ```Tools
Markdownlint
76-76: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
116-119: Hyphenate "user defined" for clarity.The phrase "user defined" should be hyphenated as "user-defined" for clarity.
- Path to a YAML file with a description of the user defined animations. + Path to a YAML file with a description of the user-defined animations.
132-135: Revise the sentence for clarity.The sentence "Should be false when there is a controller that sends this information" is incomplete. It should be revised for clarity.
- Should be false when there is a controller that sends this information. + This should be set to false when there is a controller that sends this information.
170-170: Remove the space in the abbreviation "e. g."The abbreviation "e. g." should not contain a space.
- The list of the robots spawned in the simulation e. g. `robots:='robot1={x: 1.0, y: -2.0}; robot2={x: 1.0, y: -4.0}'` + The list of the robots spawned in the simulation e.g. `robots:='robot1={x: 1.0, y: -2.0}; robot2={x: 1.0, y: -4.0}'`Tools
LanguageTool
[uncategorized] ~170-~170: There should be no space here.
Context: ...of the robots spawned in the simulation e. g. `robots:='robot1={x: 1.0, y: -2.0}; rob...(EG_SPACE)
161-161: Revise "amount of calculations" to "number of calculations".The phrase "amount of calculations" should be revised to "number of calculations".
- Useful when a GUI is not needed or to reduce the amount of calculations. + Useful when a GUI is not needed or to reduce the number of calculations.Tools
LanguageTool
[uncategorized] ~161-~161: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...en a GUI is not needed or to reduce the amount of calculations.
bool: `Fal...(AMOUNTOF_TO_NUMBEROF)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (13)
- README.md (1 hunks)
- panther_battery/README.md (2 hunks)
- panther_bringup/README.md (1 hunks)
- panther_controller/CONFIGURATION.md (1 hunks)
- panther_controller/README.md (1 hunks)
- panther_description/README.md (1 hunks)
- panther_diagnostics/README.md (1 hunks)
- panther_gazebo/README.md (1 hunks)
- panther_gazebo/launch/simulate_multiple_robots.launch.py (1 hunks)
- panther_hardware_interfaces/README.md (5 hunks)
- panther_lights/README.md (1 hunks)
- panther_localization/README.md (1 hunks)
- panther_manager/README.md (3 hunks)
Files skipped from review as they are similar to previous changes (3)
- panther_battery/README.md
- panther_controller/CONFIGURATION.md
- panther_controller/README.md
Additional context used
Learnings (1)
panther_hardware_interfaces/README.md (1)
Learnt from: pawelirh PR: husarion/panther_ros#343 File: panther_hardware_interfaces/README.md:46-54 Timestamp: 2024-06-12T15:55:50.434Z Learning: The `panther_controller` package is responsible for launching and remapping plugins that expose the API, while the `panther_hardware_interfaces` package should handle the implementation and documentation of these services.
LanguageTool
panther_diagnostics/README.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...(./config/system_status_parameters.yaml): defines parameters for `system_status_n...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~17-~17: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
panther_description/README.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~20-~20: Consider removing “of” to be more concise
Context: ...ible for continually publish values for all of the movable joints in the URDF to the `/joi...(ALL_OF_THE)
panther_lights/README.md
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): describe the appearance and parameters ...(UNLIKELY_OPENING_PUNCTUATION)
panther_localization/README.md
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
panther_manager/README.md
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ights.xml](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [P...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ..../behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...afety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managin...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...own.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...l](./config/lights_manager_config.yaml): Contains parameters for thelights_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...l](./config/safety_manager_config.yaml): Contains parameters for thesafety_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...sts.yaml`](./config/shutdown_hosts.yaml): Lists all hosts to request shutdown. #...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/README.md
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...l`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configura...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ..._strips.yaml`](./config/led_strips.yaml): configure properties of led strips in s...(UNLIKELY_OPENING_PUNCTUATION)
panther_bringup/README.md
[style] ~29-~29: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
README.md
[uncategorized] ~74-~74: The preposition ‘for’ seems more likely in this position.
Context: ...physical robot | | 🖥️ | Available in simulated robot | 'battery_config_...(AI_HYDRA_LEO_REPLACE_IN_FOR)
[style] ~152-~152: To form a complete sentence, be sure to include a subject.
Context: ...h information about the wheel position. Should be false when there is a controller tha...(MISSING_IT_THERE)
[uncategorized] ~161-~161: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...en a GUI is not needed or to reduce the amount of calculations.
bool: `Fal...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~170-~170: There should be no space here.
Context: ...of the robots spawned in the simulation e. g. `robots:='robot1={x: 1.0, y: -2.0}; rob...(EG_SPACE)
[uncategorized] ~175-~175: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations.
string:None...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~187-~187: “Other things” (plural) doesn’t require “other” to be in plural.
Context: ... | > [!TIP] > > Others packages also contains ## Developer Info ### S...(OTHERS)
Markdownlint
README.md
179-179: null
Spaces inside code span elements(MD038, no-space-in-code)
76-76: Expected: fenced; Actual: indented
Code block style(MD046, code-block-style)
Additional comments not posted (29)
panther_diagnostics/README.md (2)
5-7: LGTM!The description for
system_status.launch.pyis clear and concise.
19-19: LGTM!The documentation for
system_status_nodeis clear and well-structured.panther_description/README.md (2)
5-7: LGTM!The description for
load_urdf.launch.pyis clear and concise.
23-41: LGTM!The documentation for
joint_state_publisherandrobot_state_publisheris clear and well-structured.panther_lights/README.md (3)
3-5: LGTM!The introductory statement and the description for
lights.launch.pyare clear and concise.
17-22: LGTM!The descriptions for
lights_container,lights_controller,lights_driver, andlights_managerare clear and well-structured.
24-41: LGTM!The documentation for
lights_driverandlights_controller_nodeis clear and well-structured.panther_gazebo/launch/simulate_multiple_robots.launch.py (1)
40-40: LGTM! The addition ofchoicesenhances input validation.The
choicesargument restricts the input options for theadd_world_transformargument to "True" and "False", improving input validation and robustness.panther_localization/README.md (3)
20-23: LGTM! The table format enhances readability.The table format for listing ROS nodes improves readability and organization. The descriptions are clear and informative.
25-63: LGTM! The detailed descriptions enhance comprehensiveness.The detailed descriptions of the
ekf_filterandnavsat_transformnodes improve the comprehensiveness of the documentation. The information is well-organized and easy to understand.
13-16: Fix loose punctuation marks.The descriptions of the configuration files have loose punctuation marks. Consider fixing them for better readability.
- [`enu_localization.yaml`](./config/enu_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. - [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. - [`relative_localization.yaml`](./config/relative_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**. The initial orientation is always 0 in relative mode. - [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode. + [`enu_localization.yaml`](./config/enu_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. + [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. + [`relative_localization.yaml`](./config/relative_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. The initial orientation is always 0 in relative mode. + [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
panther_manager/README.md (3)
5-9: LGTM! The dedicated "Launch Files" section is clear and concise.The dedicated "Launch Files" section provides clear and concise information about the
manager_bt.launch.pyfile, aiding users in setup.
22-27: LGTM! The streamlined "ROS Nodes" section improves readability.The streamlined "ROS Nodes" section focuses on essential functionalities and uses a standardized table format, enhancing clarity and organization.
Line range hint
29-83:
LGTM! The detailed descriptions enhance comprehensiveness.The detailed descriptions of the
lights_managerandsafety_managernodes improve the comprehensiveness of the documentation. The information is well-organized and easy to understand.README.md (15)
80-83: LGTM!The changes look good to me.
84-87: LGTM!The changes look good to me.
88-91: LGTM!The changes look good to me.
92-95: LGTM!The changes look good to me.
96-99: LGTM!The changes look good to me.
100-103: LGTM!The changes look good to me.
104-107: LGTM!The changes look good to me.
108-111: LGTM!The changes look good to me.
112-115: LGTM!The changes look good to me.
120-123: LGTM!The changes look good to me.
124-127: LGTM!The changes look good to me.
128-131: LGTM!The changes look good to me.
136-139: LGTM!The changes look good to me.
140-145: LGTM!The changes look good to me.
146-149: LGTM!The changes look good to me.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
panther_localization/README.md (5)
9-9: Clarify the description oflocalization.launch.py.The description could be more concise and clear.
- `localization.launch.py` - is responsible for activating EKF filtration along with the necessary dependencies needed to operate GPS. + `localization.launch.py` - activates EKF filtration and necessary dependencies for GPS operation.
13-16: Fix punctuation in configuration file descriptions.The descriptions have loose punctuation marks.
- [`enu_localization.yaml`](./config/enu_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. - [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. - [`relative_localization.yaml`](./config/relative_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**. The initial orientation is always 0 in relative mode. - [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode. + [`enu_localization.yaml`](./config/enu_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. + [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. + [`relative_localization.yaml`](./config/relative_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes using **wheel encoders** and **IMU**. The initial orientation is always 0 in relative mode. + [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
20-23: Ensure consistency in node descriptions.The descriptions should be consistent in style and format.
- `ekf_filter` | The Extended Kalman Filter node is designed to fuse odometry data from various sources, including wheel encoders, IMU, and GPS. <br/> *[robot_localization/ekf_filter](https://github.com/cra-ros-pkg/robot_localization)* | - `navsat_transform` | It converts raw GPS data into odometry data and publishes corrected GPS positions based on sensor data at a higher frequency. <br/> *[robot_localization/navsat_transform](https://github.com/cra-ros-pkg/robot_localization)* | + `ekf_filter` | Fuses odometry data from various sources, including wheel encoders, IMU, and GPS. <br/> *[robot_localization/ekf_filter](https://github.com/cra-ros-pkg/robot_localization)* | + `navsat_transform` | Converts raw GPS data into odometry data and publishes corrected GPS positions based on sensor data at a higher frequency. <br/> *[robot_localization/navsat_transform](https://github.com/cra-ros-pkg/robot_localization)* |
27-41: Clarify and correct descriptions inekf_filtersection.Some descriptions could be clearer and more accurate.
- `cmd_vel` [*geometry_msgs/msg/Twist*]: command velocity value. + `cmd_vel` [*geometry_msgs/msg/Twist*]: commanded velocity value. - `localization/set_pose` [*geometry_msgs/msg/PoseWithCovarianceStamped*]: allows manually set the state of the filter by sending the pose. + `localization/set_pose` [*geometry_msgs/msg/PoseWithCovarianceStamped*]: allows manually setting the state of the filter by sending the pose. - `odometry/filtered` [*nav_msgs/msg/Odometry*]: contains information about the filtered position and orientation. When `localization_mode` is `relative`, the position and orientation are relative to the starting point. When `localization_mode` is `enu`, the orientation is relative to the east-north-up (ENU) coordinates. + `odometry/filtered` [*nav_msgs/msg/Odometry*]: contains information about the filtered position and orientation. When `localization_mode` is `relative`, the position and orientation are relative to the starting point. When `localization_mode` is `enu`, the orientation follows East-North-Up (ENU) coordinates.
51-56: Clarify and correct descriptions innavsat_transformsection.Some descriptions could be clearer and more accurate.
- `gps/fix` [*sensor_msgs/msg/NavSatFix*]: raw GPS data. + `gps/fix` [*sensor_msgs/msg/NavSatFix*]: raw GPS data from the GPS receiver. - `gps/filtered` [*sensor_msgs/msg/NavSatFix*]: GPS position after including sensor data from `ekf_filter`. + `gps/filtered` [*sensor_msgs/msg/NavSatFix*]: GPS position after fusion with sensor data from `ekf_filter`.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- panther_localization/README.md (1 hunks)
Additional context used
LanguageTool
panther_localization/README.md
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (1)
panther_localization/README.md (1)
47-47: Ensure link accuracy and clarity in parameter descriptions.Verify that the links are correct and descriptions are clear.
Verification successful
Links in the parameter descriptions are correct and accessible.
The links provided in the parameter descriptions of the README.md file are verified to be correct and accessible.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the links provided in the parameter descriptions. # Test: Check if the links are accessible and correct. curl -I http://docs.ros.org/en/api/robot_localization/html/state_estimation_nodes.html curl -I http://docs.ros.org/en/api/robot_localization/html/navsat_transform_node.htmlLength of output: 1241
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range, codebase verification and nitpick comments (5)
panther_lights/README.md (1)
1-4: Improve the introductory description.The introductory description can be more informative by including details about the package's functionality and purpose.
- Package used to control the Husarion Panther Bumper Lights. + This package is used to control the Husarion Panther Bumper Lights, including managing animations and LED configurations.panther_lights/CONFIGURATION.md (2)
1-5: Improve the introductory description.The introductory description can be more informative by including details about the purpose and functionality of the configuration file.
- Basic led configuration is loaded from [`led_config.yaml`](config/led_config.yaml) file. It includes definition of robot panels, virtual segments and default animations. + The basic LED configuration is loaded from the [`led_config.yaml`](config/led_config.yaml) file. It includes definitions of robot panels, virtual segments, and default animations.
165-167: Improve the description of defining a custom animation type.The description can be more informative by including details about the purpose and functionality of custom animation types.
- It is possible to define your own animation type with expected, new behavior. For more information, see: [**Animation API**](LIGHTS_API.md). + It is possible to define your own animation type with new and expected behavior. For more information, see: [**Animation API**](LIGHTS_API.md).panther_gazebo/README.md (2)
Line range hint
1-4: Improve the introductory description.The introductory description can be more informative by including details about the package's functionality and purpose.
- The package contains a launch file and source files used to run the robot simulation in Gazebo. The simulator tries to reproduce the behavior of a real robot as much as possible, including the provision of an analogous ROS_API. + This package contains launch files and source files used to run the robot simulation in Gazebo. The simulator aims to reproduce the behavior of a real robot as closely as possible, including providing an analogous ROS API.Tools
LanguageTool
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...l`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configura...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...z_bridge.yaml`](./config/gz_bridge.yaml): specify data to exchange between ROS an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ..._strips.yaml`](./config/led_strips.yaml): configure properties of led strips in s...(UNLIKELY_OPENING_PUNCTUATION)
5-10: Fix grammatical errors and improve clarity.There are grammatical errors and clarity issues in the descriptions of the launch files.
- spawn_robot.launch.py - is responsible for spawning the robot in the simulator. - simulate_robot.launch.py - is responsible for giving birth to the robot and simulating its physical behavior, such as driving, displaying data, etc. - simulate_multiple_robots.launch.py - similar to the above with logic allowing you to quickly add a swarm of robots. - simulation.launch.py - a target file that runs the gazebo simulator that adds and simulates the robot's behavior in accordance with the given arguments. + `spawn_robot.launch.py` - responsible for spawning the robot in the simulator. + `simulate_robot.launch.py` - responsible for initializing the robot and simulating its physical behavior, such as driving and displaying data. + `simulate_multiple_robots.launch.py` - similar to the above, with logic allowing you to quickly add a swarm of robots. + `simulation.launch.py` - a target file that runs the Gazebo simulator and simulates the robot's behavior according to the given arguments.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (6)
- .pre-commit-config.yaml (1 hunks)
- ROS_API.md (1 hunks)
- panther_gazebo/README.md (1 hunks)
- panther_hardware_interfaces/README.md (5 hunks)
- panther_lights/CONFIGURATION.md (1 hunks)
- panther_lights/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .pre-commit-config.yaml
Additional context used
LanguageTool
panther_lights/README.md
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~38-~38: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### lights_driver #### Pu...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_lights/CONFIGURATION.md
[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...ween multiple panels. -number_of_leds: defines the total number of LEDs presen...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~30-~30: Loose punctuation mark.
Context: ... segment has three attributes: -name: the identifier for the segment, such as...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...e between multiple segments. -channel: This specifies which LED panel the segm...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...d in thepanelssection. -led_range: This defines the range of LEDs within t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~150-~150: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 6813 characters long)
Context: ...are reserved for system animations. > [!NOTE] > Priority 1 is reserved for c...(EN_EXCESSIVE_EXCLAMATION)
panther_gazebo/README.md
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...l`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configura...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...z_bridge.yaml`](./config/gz_bridge.yaml): specify data to exchange between ROS an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ..._strips.yaml`](./config/led_strips.yaml): configure properties of led strips in s...(UNLIKELY_OPENING_PUNCTUATION)
ROS_API.md
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...S 2 Driver for Panther. It is functional and the architecture will not change signif...(COMMA_COMPOUND_SENTENCE_2)
Markdownlint
panther_lights/CONFIGURATION.md
149-149: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
Additional comments not posted (15)
panther_lights/README.md (3)
5-9: Correct description oflights.launch.py.The description of
lights.launch.pyseems to be incorrect. It mentions EKF filtration and GPS, which are unrelated to lights.- lights.launch.py - is responsible for activating EKF filtration along with the necessary dependencies needed to operate GPS + lights.launch.py - is responsible for launching the nodes required to control the Panther Bumper Lights.
11-13: Fix punctuation issue.There is a punctuation issue in the description of
led_config.yaml.- describe the appearance and parameters of the animation + describes the appearance and parameters of the animations.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
17-21: Fix broken link.The link to
panther_lights/ControllerNodeis broken and needs to be corrected.- [panther_lights/ControllerNode](./panther_lights) + [panther_lights/ControllerNode](../panther_lights/src/controller_node.cpp)panther_lights/CONFIGURATION.md (3)
26-33: Fix grammatical errors and missing articles.There are several grammatical errors and missing articles in this section.
- The `segments` section is used to create virtual segments on the robot by dividing the LED panels into different parts. This allows for more precise control over which LEDs are lit up for different effects or indicators. Each segment has three attributes: - - `name`: the identifier for the segment, such as "front" or "rear". It is used to differentiate between multiple segments. - - `channel`: This specifies which LED panel the segment belongs to. It has to match one of the channels defined in the `panels` section. - - `led_range`: This defines the range of LEDs within the panel that the segment covers. The range is specified as a start-end pair (e.g. 0-45). The range can be specified in reverse order (e.g. 45-0), which may be useful for wiring or orientation reasons. + The `segments` section is used to create virtual segments on the robot by dividing the LED panels into different parts. This allows for more precise control over which LEDs are lit up for different effects or indicators. Each segment has three attributes: + - `name`: the identifier for the segment, such as "front" or "rear". It is used to differentiate between multiple segments. + - `channel`: This specifies which LED panel the segment belongs to. It has to match one of the channels defined in the `panels` section. + - `led_range`: This defines the range of LEDs within the panel that the segment covers. The range is specified as a start-end pair (e.g., 0-45). The range can be specified in reverse order (e.g., 45-0), which may be useful for wiring or orientation reasons.Tools
LanguageTool
[uncategorized] ~30-~30: Loose punctuation mark.
Context: ... segment has three attributes: -name: the identifier for the segment, such as...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~31-~31: Loose punctuation mark.
Context: ...e between multiple segments. -channel: This specifies which LED panel the segm...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~32-~32: Loose punctuation mark.
Context: ...d in thepanelssection. -led_range: This defines the range of LEDs within t...(UNLIKELY_OPENING_PUNCTUATION)
42-57: Fix grammatical errors and missing articles.There are several grammatical errors and missing articles in this section.
- The `led_animations` section contains list with definitions for various animations that can be displayed on the LED segments. Supported keys are: - - `animations` [*list*, default: **None**]: definition of animation for each Bumper Lights. Supported keys are: - - `type` [*string*, default **None**]: Specifies the type of animation. Default animation types are: `panther_lights::ImageAnimation`, `panther_lights::ChargingAnimation`. - - `segments` [*string*, default **None**]: Indicates which segment mapping this particular animation applies to (e.g., all, front, rear). - - `animation` [*yaml*, default: **None**]: An animation to be displayed on segments. The keys for the configuration of different animation types are explained in detail under the [**Animation Types**](#animation-types) section. - - `id` [*int*, default: **None**]: unique ID of an animation. - - `name` [*string*, default: **ANIMATION_`ID`**]: name of an animation. If not provided, it will default to **ANIMATION_`ID`**, where `ID` is equal to `id` parameter of the given animation. - - `priority` [*int*, default: **3**]: priority at which animation will be placed in the queue. The list below shows the behavior when an animation with a given ID arrives: - - **1** interrupts and removes animation with priorities **2** and **3**. - - **2** interrupts animations with priority **3**. - - **3** adds animation to the end of the queue. - - `timeout` [*float*, default: **120.0**]: time in **[s]**, after which animation will be removed from the queue. + The `led_animations` section contains a list with definitions for various animations that can be displayed on the LED segments. Supported keys are: + - `animations` [*list*, default: **None**]: definition of animation for each Bumper Lights. Supported keys are: + - `type` [*string*, default **None**]: Specifies the type of animation. Default animation types are: `panther_lights::ImageAnimation`, `panther_lights::ChargingAnimation`. + - `segments` [*string*, default **None**]: Indicates which segment mapping this particular animation applies to (e.g., all, front, rear). + - `animation` [*yaml*, default: **None**]: An animation to be displayed on segments. The keys for the configuration of different animation types are explained in detail under the [**Animation Types**](#animation-types) section. + - `id` [*int*, default: **None**]: unique ID of an animation. + - `name` [*string*, default: **ANIMATION_`ID`**]: name of an animation. If not provided, it will default to **ANIMATION_`ID`**, where `ID` is equal to the `id` parameter of the given animation. + - `priority` [*int*, default: **3**]: priority at which animation will be placed in the queue. The list below shows the behavior when an animation with a given ID arrives: + - **1** interrupts and removes animation with priorities **2** and **3**. + - **2** interrupts animations with priority **3**. + - **3** adds animation to the end of the queue. + - `timeout` [*float*, default: **120.0**]: time in **[s]**, after which animation will be removed from the queue.
82-145: Fix typo in the second animation example.The
imagepath should be corrected to use the correct syntax.- image: /animations/custom_image.png + image: $(find panther_lights)/animations/custom_image.pngpanther_gazebo/README.md (1)
12-17: Fix punctuation issues.There are punctuation issues in the descriptions of the configuration files.
- [`battery_plugin_config.yaml`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configuration. - [`gz_bridge.yaml`](./config/gz_bridge.yaml): specify data to <details> <summary>Tools</summary> <details> <summary>LanguageTool</summary><blockquote> [uncategorized] ~14-~14: Loose punctuation mark. Context: ...l`](./config/battery_plugin_config.yaml): simulated LinearBatteryPlugin configura... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~15-~15: Loose punctuation mark. Context: ...z_bridge.yaml`](./config/gz_bridge.yaml): specify data to exchange between ROS an... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~16-~16: Loose punctuation mark. Context: ..._strips.yaml`](./config/led_strips.yaml): configure properties of led strips in s... (UNLIKELY_OPENING_PUNCTUATION) </blockquote></details> </details> </blockquote></details> <details> <summary>panther_hardware_interfaces/README.md (5)</summary><blockquote> `7-7`: **Approved: Link to `panther_description` package.** The link to the `panther_description` package is correct and relevant. --- `9-12`: **Approved: Node descriptions.** The table provides clear and well-structured descriptions of the nodes. --- `49-51`: **Approved: CAN settings descriptions.** The descriptions of CAN settings and the links to `canopen_configuration.yaml` are correct and clear. --- `130-130`: **Approved: Link to `CODE_STRUCTURE.md`.** The link to the `CODE_STRUCTURE.md` file is correct and relevant. --- `69-69`: **Fix grammatical error in the description of parameters.** The sentence should be rephrased for clarity. ```diff - Required parameters are defined when including the interface in the URDF (you can check out [panther_macro.urdf.xacro](../panther_description/urdf/panther_macro.urdf.xacro)). + Required parameters are defined when including the interface in the URDF (you can check out [panther_macro.urdf.xacro](../panther_description/urdf/panther_macro.urdf.xacro)).Likely invalid or redundant comment.
ROS_API.md (3)
29-29: Approved: Link to Panther ROS 2 API Diagram.The link to the Panther ROS 2 API Diagram is correct and relevant.
41-66: Approved: Topic descriptions.The table provides clear and well-structured descriptions of the topics.
75-100: Approved: Service descriptions.The table provides clear and well-structured descriptions of the services.
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range, codebase verification and nitpick comments (12)
panther_bringup/README.md (1)
9-9: Fix punctuation issue.The colon should be replaced with a period to avoid loose punctuation.
- - `bringup.launch.py`: Responsible for activating whole robot system. + - `bringup.launch.py`. Responsible for activating the whole robot system.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -bringup.launch.py: Responsible for activating whole robot ...(UNLIKELY_OPENING_PUNCTUATION)
panther_description/README.md (2)
7-7: Fix punctuation issue.The hyphen should be replaced with a period to avoid loose punctuation.
- - `load_urdf.launch.py` - loads the robot's URDF and creates simple bindings to display moving joints. + - `load_urdf.launch.py`. Loads the robot's URDF and creates simple bindings to display moving joints.
11-14: Fix punctuation issues.The colons should be replaced with periods to avoid loose punctuation.
- - [`components.yaml`](./config/components.yaml): Allows you to quickly add visualization of sensors, TF connections and simulate their behavior in the simulator. - - [`WH01.yaml`](./config/WH01.yaml): Description of physical and visual parameters for the wheel WH01. - - [`WH02.yaml`](./config/WH02.yaml): Description of physical and visual parameters for the wheel WH02. - - [`WH04.yaml`](./config/WH04.yaml): Description of physical and visual parameters for the wheel WH04. + - [`components.yaml`](./config/components.yaml). Allows you to quickly add visualization of sensors, TF connections and simulate their behavior in the simulator. + - [`WH01.yaml`](./config/WH01.yaml). Description of physical and visual parameters for the wheel WH01. + - [`WH02.yaml`](./config/WH02.yaml). Description of physical and visual parameters for the wheel WH02. + - [`WH04.yaml`](./config/WH04.yaml). Description of physical and visual parameters for the wheel WH04.Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): Allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
panther_controller/README.md (2)
7-7: Fix punctuation issue.The colon should be replaced with a period to avoid loose punctuation.
- - `controller.launch.py`: Establishes communication with the hardware by loading the robot's URDF with plugins and configures the controllers to exchange information between the engine driver and the IMU. + - `controller.launch.py`. Establishes communication with the hardware by loading the robot's URDF with plugins and configures the controllers to exchange information between the engine driver and the IMU.Tools
LanguageTool
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...# Launch Files -controller.launch.py: Establishes communication with the hard...(UNLIKELY_OPENING_PUNCTUATION)
11-13: Fix punctuation issues.The colons should be replaced with periods to avoid loose punctuation.
- - [`WH01_controller.yaml`](./config/WH01_controller.yaml): Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for default WH01 wheels. - - [`WH02_controller.yaml`](./config/WH02_controller.yaml): Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for mecanum WH02 wheels. - - [`WH04_controller.yaml`](./config/WH04_controller.yaml): Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for small pneumatic WH04 wheels. + - [`WH01_controller.yaml`](./config/WH01_controller.yaml). Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for default WH01 wheels. + - [`WH02_controller.yaml`](./config/WH02_controller.yaml). Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for mecanum WH02 wheels. + - [`WH04_controller.yaml`](./config/WH04_controller.yaml). Configures `imu_broadcaster`, `joint_state_broadcaster` and `drive_controller` controllers for small pneumatic WH04 wheels.Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...er.yaml](./config/WH01_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...er.yaml](./config/WH02_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...er.yaml](./config/WH04_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
panther_battery/README.md (1)
9-9: Fix grammatical error.The phrase "which dealing with" should be "which deals with".
- Responsible for activating battery node, which dealing with reading and publishing battery data. + Responsible for activating the battery node, which deals with reading and publishing battery data.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
panther_lights/README.md (3)
9-9: Fix grammatical error.The phrase "which dealing with" should be "which deals with".
- Responsible for launching the nodes required to control the Panther Bumper Lights. + Responsible for launching the nodes required to control the Panther Bumper Lights.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
13-13: Fix grammatical error.The phrase "defines and describes" should be "define and describe".
- Defines and describes the appearance and parameters of the animations. + Define and describe the appearance and parameters of the animations.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
17-17: Fix grammatical error.The phrase "manages" should be "manages".
- Node for managing ROS components. This node manages: `lights_controller`, `lights_driver`. + Node for managing ROS components. This node manages: `lights_controller`, `lights_driver`.Tools
LanguageTool
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...2/rclcpp/tree/rolling/rclcpp_components): Node for managing ROS components. This ...(UNLIKELY_OPENING_PUNCTUATION)
panther_manager/README.md (3)
9-9: Fix grammatical error.The phrase "which dealing with" should be "which deals with".
- Responsible for launching behavior trees responsible for safety and LED animations scheduling. + Responsible for launching behavior trees responsible for safety and LED animations scheduling.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...kage contains: -manager_bt.launch.py: Responsible for launching behavior tree...(UNLIKELY_OPENING_PUNCTUATION)
13-13: Fix grammatical error.The phrase "defines and describes" should be "define and describe".
- Defines and describes the appearance and parameters of the animations. + Define and describe the appearance and parameters of the animations.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ights.xml](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [P...(UNLIKELY_OPENING_PUNCTUATION)
17-17: Fix grammatical error.The phrase "manages" should be "manages".
- Node for managing ROS components. This node manages: `lights_controller`, `lights_driver`. + Node for managing ROS components. This node manages: `lights_controller`, `lights_driver`.Tools
LanguageTool
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...own.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown pr...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (11)
- ROS_API.md (1 hunks)
- panther_battery/README.md (1 hunks)
- panther_bringup/README.md (1 hunks)
- panther_controller/README.md (1 hunks)
- panther_description/README.md (1 hunks)
- panther_diagnostics/README.md (1 hunks)
- panther_gazebo/README.md (1 hunks)
- panther_hardware_interfaces/README.md (3 hunks)
- panther_lights/README.md (1 hunks)
- panther_localization/README.md (1 hunks)
- panther_manager/README.md (1 hunks)
Additional context used
LanguageTool
panther_bringup/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -bringup.launch.py: Responsible for activating whole robot ...(UNLIKELY_OPENING_PUNCTUATION)
panther_description/README.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): Allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
panther_controller/README.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...# Launch Files -controller.launch.py: Establishes communication with the hard...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...er.yaml](./config/WH01_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...er.yaml](./config/WH02_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...er.yaml](./config/WH04_controller.yaml): Configuresimu_broadcaster,joint_st...(UNLIKELY_OPENING_PUNCTUATION)
panther_gazebo/README.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ... Launch Files -spawn_robot.launch.py: Responsible for spawning the robot in t...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ... simulator. -simulate_robot.launch.py: Responsible for giving birth to the rob...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ... of robots. -simulation.launch.py: A target file that runs the gazebo simu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...l`](./config/battery_plugin_config.yaml): Simulated LinearBatteryPlugin configura...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...z_bridge.yaml`](./config/gz_bridge.yaml): Specify data to exchange between ROS an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ..._strips.yaml`](./config/led_strips.yaml): Configure properties of led strips in s...(UNLIKELY_OPENING_PUNCTUATION)
panther_localization/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...ge contains: -localization.launch.py: Responsible for activating EKF filtrati...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
panther_diagnostics/README.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...aunch Files -system_status.launch.py: Launch a node that analyzes the state o...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...(./config/system_status_parameters.yaml): Defines parameters for `system_status_n...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...ystem_status_node`](#system_status_node): Publishes system state of the Built-in...(UNLIKELY_OPENING_PUNCTUATION)
panther_battery/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...Nodes -battery_node: Publishes battery state read from ADC u...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...2/rclcpp/tree/rolling/rclcpp_components): Node for managing ROS components. This ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~36-~36: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### lights_driver #### Pu...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_manager/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...kage contains: -manager_bt.launch.py: Responsible for launching behavior tree...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ights.xml](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [P...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ..../behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...afety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managin...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...own.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...l](./config/lights_manager_config.yaml): Contains parameters for thelights_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...l](./config/safety_manager_config.yaml): Contains parameters for thesafety_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...sts.yaml`](./config/shutdown_hosts.yaml): List with all hosts to request shutdown...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...s -lights_manager: Node responsible for managing Bumper Li...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...g. -safety_manager: Node responsible for managing safety fe...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~83-~83: The singular proper name ‘Ping’ must be used with a third-person or a past tense verb.
Context: ...cess` [bool, default: true]: Ping host until it is not available or timeout is...(HE_VERB_AGR)
panther_hardware_interfaces/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...n/)).PantherSystem: Plugin responsible for communicating wi...(UNLIKELY_OPENING_PUNCTUATION)
ROS_API.md
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...S 2 Driver for Panther. It is functional and the architecture will not change signif...(COMMA_COMPOUND_SENTENCE_2)
[style] ~61-~61: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
Additional comments not posted (29)
panther_localization/README.md (1)
13-16: Fix punctuation in configuration file descriptions.The descriptions for the configuration files contain loose punctuation marks.
- [`enu_localization.yaml`](./config/enu_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. - [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. - [`relative_localization.yaml`](./config/relative_localization.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**. The initial orientation is always 0 in relative mode. - [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml): configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode. + [`enu_localization.yaml`](./config/enu_localization.yaml) - Configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders** and **IMU**. Orientation follows East-North-Up (ENU) coordinates. + [`enu_localization_with_gps.yaml`](./config/enu_localization_with_gps.yaml) - Configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. Orientation follows East-North-Up (ENU) coordinates. + [`relative_localization.yaml`](./config/relative_localization.yaml) - Configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**. The initial orientation is always 0 in relative mode. + [`relative_localization_with_gps.yaml`](./config/relative_localization_with_gps.yaml) - Configures data fusion for `ekf_filter` and `navsat_transform` nodes, using **wheel encoders**, **IMU**, and **GPS**. The initial orientation is always 0 in relative mode.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...n.yaml](./config/enu_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../config/enu_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...l](./config/relative_localization.yaml): configures data fusion forekf_filter`...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...fig/relative_localization_with_gps.yaml): configures data fusion forekf_filter...(UNLIKELY_OPENING_PUNCTUATION)
panther_diagnostics/README.md (2)
7-7: Fix punctuation in launch file description.The description for the launch file contains a loose punctuation mark.
- `system_status.launch.py`: Launch a node that analyzes the state of the most important components in the robot. + `system_status.launch.py` - Launch a node that analyzes the state of the most important components in the robot.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ...aunch Files -system_status.launch.py: Launch a node that analyzes the state o...(UNLIKELY_OPENING_PUNCTUATION)
11-11: Fix punctuation in configuration file description.The description for the configuration file contains a loose punctuation mark.
- [`system_status_parameters.yaml`](./config/system_status_parameters.yaml): Defines parameters for `system_status_node`. + [`system_status_parameters.yaml`](./config/system_status_parameters.yaml) - Defines parameters for `system_status_node`.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...(./config/system_status_parameters.yaml): Defines parameters for `system_status_n...(UNLIKELY_OPENING_PUNCTUATION)
panther_battery/README.md (5)
3-3: LGTM!The updated description is clear and concise.
13-13: LGTM!The node name update from
battery_drivertobattery_nodeis appropriate.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...Nodes -battery_node: Publishes battery state read from ADC u...(UNLIKELY_OPENING_PUNCTUATION)
19-23: LGTM!The documentation for publishing topics is clear and detailed.
27-28: LGTM!The documentation for subscribing topics is clear and detailed.
34-39: LGTM!The documentation for parameters is clear and detailed.
Tools
LanguageTool
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md (3)
19-19: LGTM!The node description for
lights_controller_nodeis clear and concise.
25-26: LGTM!The documentation for publishing topics is clear and detailed.
36-36: LGTM!The documentation for parameters is clear and detailed.
Tools
LanguageTool
[uncategorized] ~36-~36: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### lights_driver #### Pu...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_manager/README.md (3)
19-19: LGTM!The node description for
lights_controller_nodeis clear and concise.Tools
LanguageTool
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...l](./config/safety_manager_config.yaml): Contains parameters for thesafety_man...(UNLIKELY_OPENING_PUNCTUATION)
25-26: LGTM!The documentation for publishing topics is clear and detailed.
Tools
LanguageTool
[uncategorized] ~25-~25: Loose punctuation mark.
Context: ...g. -safety_manager: Node responsible for managing safety fe...(UNLIKELY_OPENING_PUNCTUATION)
36-36: LGTM!The documentation for parameters is clear and detailed.
panther_hardware_interfaces/README.md (8)
7-7: LGTM!The description and the link to the
panther_descriptionpackage are correct.
9-10: LGTM!The descriptions of the
PantherSystemandPantherImuSensorplugins are clear and concise.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...n/)).PantherSystem: Plugin responsible for communicating wi...(UNLIKELY_OPENING_PUNCTUATION)
34-42: LGTM!The grammatical error in the description of parameters has been fixed. The descriptions of the parameters are clear and concise.
46-58: LGTM!The descriptions of the CAN settings are clear and concise.
67-67: LGTM!The grammatical error in the description of parameters has been fixed. The descriptions of the parameters are clear and concise.
128-128: LGTM!The link to the separate file describing the code structure is correct.
Line range hint
133-133: LGTM!The instructions for generating CAN config are clear and concise.
Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...n/)).PantherSystem: Plugin responsible for communicating wi...(UNLIKELY_OPENING_PUNCTUATION)
Line range hint
138-138: LGTM!The instructions for setting up and running tests are clear and concise.
Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...n/)).PantherSystem: Plugin responsible for communicating wi...(UNLIKELY_OPENING_PUNCTUATION)
ROS_API.md (7)
1-13: LGTM!The introduction and warning about the beta release are clear and provide necessary information.
Tools
LanguageTool
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...S 2 Driver for Panther. It is functional and the architecture will not change signif...(COMMA_COMPOUND_SENTENCE_2)
27-29: LGTM!The diagram link is correct.
31-33: LGTM!The descriptions of the ROS interfaces are clear and concise.
41-62: LGTM!The descriptions of the nodes available in the Panther ROS system are clear and concise.
Tools
LanguageTool
[style] ~61-~61: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
63-88: LGTM!The descriptions of the topics available in the Panther ROS system are clear and concise.
89-96: LGTM!The descriptions of the hidden topics available in the Panther ROS system are clear and concise.
97-122: LGTM!The descriptions of the services available in the Panther ROS system are clear and concise.
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (6)
panther_battery/README.md (2)
9-9: Fix grammatical issues.There are minor grammatical issues and a missing article in the description.
- Responsible for activating battery node, which dealing with reading and publishing battery data. + Responsible for activating the battery node, which deals with reading and publishing battery data.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: You might be missing the article “the” here.
Context: ....launch.py`: Responsible for activating battery node, which dealing with reading and pu...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~9-~9: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...ible for activating battery node, which dealing with reading and publishing battery dat...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
13-13: Fix typographical error.There is a minor typographical error in the word "versions".
- or based on Roboteq motor controllers' data for earlier.versions of the robot. + or based on Roboteq motor controllers' data for earlier versions of the robot.panther_lights/README.md (2)
9-9: Fix punctuation issue.There is a minor punctuation issue in the description.
- Responsible for launching the nodes required to control the Panther Bumper Lights. + Responsible for launching the nodes required to control the Panther Bumper Lights.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
13-13: Fix punctuation issue.There is a minor punctuation issue in the description.
- Defines and describes the appearance and parameters of the animations. + Defines and describes the appearance and parameters of the animations.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
ROS_API.md (2)
47-47: Improve description for clarity.Consider adding more details about the
drive_controllernode to provide a clearer understanding of its functionality.- Manages mobile robots with a differential drive. It converts velocity commands for the robot body into wheel commands for the base. It also calculates odometry from hardware feedback and shares it. + Manages mobile robots with a differential or mecanum drive depending on configuration. It converts velocity commands for the robot body into wheel commands for the base. It also calculates odometry from hardware feedback and shares it.
119-119: Improve description for clarity.Consider adding more details about the
lights/set_brightnessservice to provide a clearer understanding of its functionality.- Sets global LED brightness, value ranges from **0.0** to **1.0**. + Sets the global LED brightness for the Panther robot's bumper lights. The value ranges from **0.0** (off) to **1.0** (maximum brightness).
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (4)
- ROS_API.md (1 hunks)
- panther_battery/README.md (1 hunks)
- panther_hardware_interfaces/README.md (3 hunks)
- panther_lights/README.md (1 hunks)
Additional context used
LanguageTool
panther_battery/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: You might be missing the article “the” here.
Context: ....launch.py`: Responsible for activating battery node, which dealing with reading and pu...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~9-~9: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...ible for activating battery node, which dealing with reading and publishing battery dat...(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### lights_driver This no...(EN_COMPOUND_ADJECTIVE_INTERNAL)
ROS_API.md
[uncategorized] ~6-~6: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...S 2 Driver for Panther. It is functional and the architecture will not change signif...(COMMA_COMPOUND_SENTENCE_2)
[style] ~61-~61: This phrase is redundant (‘M’ stands for ‘memory’). Use simply “RAM”.
Context: ...he Built-in Computer such as CPU usage, RAM memory usage, disk usage and CPU temperature....(ACRONYM_TAUTOLOGY)
Additional comments not posted (13)
panther_battery/README.md (3)
3-3: Introduction is clear and concise.The introduction succinctly describes the package's purpose.
17-26: Publishers and subscribers sections are clear and well-formatted.The sections list the topics published and subscribed by the
battery_node.
32-37: Parameters section is clear and well-formatted.The section lists the parameters used by the
battery_node.Tools
LanguageTool
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md (2)
3-3: Introduction is clear and concise.The introduction succinctly describes the package's purpose.
15-61: ROS nodes section is clear and well-structured.The section describes the
lights_controller_nodeandlights_drivernodes and their functionalities.Tools
LanguageTool
[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### lights_driver This no...(EN_COMPOUND_ADJECTIVE_INTERNAL)
panther_hardware_interfaces/README.md (5)
3-3: Introduction is clear and concise.The introduction succinctly describes the package's purpose.
7-7: ROS nodes section is clear and concise.The section describes the absence of standalone nodes and the usage of plugins.
Line range hint
11-33: PantherSystem section is clear and well-structured.The section describes the
PantherSystemplugin and its functionalities.
Line range hint
64-129: PantherImuSensor section is clear and well-structured.The section describes the
PantherImuSensorplugin and its functionalities.
Line range hint
129-174: Code structure and testing sections are clear and well-structured.The sections describe the code structure and testing procedures.
ROS_API.md (3)
33-33: LGTM!The section clearly describes the physical robot API and the simulation API.
63-63: LGTM!The section clearly describes the topics with comprehensive details and relevant links.
89-89: LGTM!The section clearly describes the hidden topics with comprehensive details and relevant links.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (19)
panther_description/README.md (3)
1-3: Add a subject to form a complete sentence.The description for the package is missing a subject. Consider rephrasing it to form a complete sentence.
- The package contains URDF files responsible for creating a representation of the robot by specifying the relationships and types of connections (joints) between individual links. It also contains information about the robot's mesh. + This package contains URDF files responsible for creating a representation of the robot by specifying the relationships and types of connections (joints) between individual links. It also contains information about the robot's mesh.
5-7: Ensure consistency in descriptions.The description of the launch file should be consistent with the rest of the documentation. Consider rephrasing for clarity.
- loads the robot's URDF and creates simple bindings to display moving joints. + Loads the robot's URDF and creates simple bindings to display moving joints.
9-14: Fix punctuation issues.There are punctuation issues in the descriptions of the configuration files. Ensure that each description forms a complete sentence.
- Allows you to quickly add visualization of sensors, TF connections and simulate their behavior in the simulator. + This file allows you to quickly add visualization of sensors, TF connections, and simulate their behavior in the simulator. - Description of physical and visual parameters for the wheel WH01. + This file contains the description of physical and visual parameters for the wheel WH01. - Description of physical and visual parameters for the wheel WH02. + This file contains the description of physical and visual parameters for the wheel WH02. - Description of physical and visual parameters for the wheel WH04. + This file contains the description of physical and visual parameters for the wheel WH04.Tools
LanguageTool
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): Allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
panther_battery/README.md (5)
1-3: Add a subject to form a complete sentence.The description for the package is missing a subject. Consider rephrasing it to form a complete sentence.
- The package containing nodes monitoring and publishing the internal battery state of the Husarion Panther robot. + This package contains nodes for monitoring and publishing the internal battery state of the Husarion Panther robot.
5-9: Fix punctuation issues.There are punctuation issues in the description of the launch file. Ensure that the description forms a complete sentence.
- Responsible for activating battery node, which dealing with reading and publishing battery data. + Responsible for activating the battery node, which deals with reading and publishing battery data.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
11-15: Fix punctuation issues and clarify descriptions.There are punctuation issues in the descriptions of the ROS nodes. Ensure that each description forms a complete sentence and is clear.
- Publishes battery state read from ADC unit for Panther version 1.2 and above, or based on Roboteq motor controllers' data for earlier.versions of the robot. + This node publishes the battery state read from the ADC unit for Panther version 1.2 and above, or based on Roboteq motor controllers' data for earlier versions of the robot.
19-23: Ensure consistency in topic descriptions.The descriptions of the topics should be consistent and clear. Consider rephrasing for clarity.
- First battery raw state. + The raw state of the first battery. - Second battery raw state. Published if second battery detected. + The raw state of the second battery. Published if a second battery is detected. - Mean values of both batteries if Panther has two batteries. Otherwise, the state of the single battery will be published. + The mean values of both batteries if the Panther has two batteries. Otherwise, the state of the single battery will be published. - Battery charging status. + The charging status of the battery. - Battery diagnostic messages. + Diagnostic messages for the battery.
27-39: Fix punctuation issues and ensure clarity in parameter descriptions.There are punctuation issues in the descriptions of the parameters. Ensure that each description forms a complete sentence and is clear.
- ADC nr 0 IIO device. Used with Panther version 1.2 and above. + The IIO device for ADC number 0. Used with Panther version 1.2 and above. - ADC nr 1 IIO device. Used with Panther version 1.2 and above. + The IIO device for ADC number 1. Used with Panther version 1.2 and above. - Window length of a moving average, used to smooth out battery charge readings. Used with Panther version 1.2 and above. + The window length of a moving average, used to smooth out battery charge readings. Used with Panther version 1.2 and above. - Window length of a moving average, used to smooth out battery temperature readings. Used with Panther version 1.2 and above. + The window length of a moving average, used to smooth out battery temperature readings. Used with Panther version 1.2 and above. - Specifies the timeout in seconds. If the node fails to read battery data exceeding this duration, the node will publish an unknown battery state. + Specifies the timeout in seconds. If the node fails to read battery data for this duration, the node will publish an unknown battery state. - Window length of a moving average, used to smooth out battery voltage readings. + The window length of a moving average, used to smooth out battery voltage readings. - Window length of a moving average, used to smooth out battery current readings. + The window length of a moving average, used to smooth out battery current readings. - Specifies timeout in seconds after which driver state messages will be considered old. Used with Panther version 1.06 and earlier. + Specifies the timeout in seconds after which driver state messages will be considered old. Used with Panther version 1.06 and earlier.Tools
LanguageTool
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md (7)
1-3: Add a subject to form a complete sentence.The description for the package is missing a subject. Consider rephrasing it to form a complete sentence.
- Package used to control the Husarion Panther Bumper Lights. + This package is used to control the Husarion Panther Bumper Lights.
5-9: Fix punctuation issues.There are punctuation issues in the description of the launch file. Ensure that the description forms a complete sentence.
- Responsible for launching the nodes required to control the Panther Bumper Lights. + This file is responsible for launching the nodes required to control the Panther Bumper Lights.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
11-13: Fix punctuation issues.There are punctuation issues in the description of the configuration file. Ensure that the description forms a complete sentence.
- Defines and describes the appearance and parameters of the animations. + This file defines and describes the appearance and parameters of the animations.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
15-19: Fix punctuation issues and clarify descriptions.There are punctuation issues in the descriptions of the ROS nodes. Ensure that each description forms a complete sentence and is clear.
- This node is of type rclcpp_components is responsible for processing animations and publishing frames to be displayed on the Husarion Panther robot Bumper Lights. + This node, of type rclcpp_components, is responsible for processing animations and publishing frames to be displayed on the Husarion Panther robot Bumper Lights.Tools
LanguageTool
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...rollerNode This node is of type rclcpp_components is responsible for processing animation...(AI_HYDRA_LEO_MISSING_COMMA)
36-38: Fix punctuation issues and clarify descriptions.There are punctuation issues in the descriptions of the ROS nodes. Ensure that each description forms a complete sentence and is clear.
- This node is of type rclcpp_components is responsible for displaying frames on the Husarion Panther robot's Bumper Lights. + This node, of type rclcpp_components, is responsible for displaying frames on the Husarion Panther robot's Bumper Lights.Tools
LanguageTool
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...DriverNode This node is of type rclcpp_components is responsible for displaying frames on...(AI_HYDRA_LEO_MISSING_COMMA)
32-34: Fix punctuation issues and ensure clarity in parameter descriptions.There are punctuation issues in the descriptions of the parameters. Ensure that each description forms a complete sentence and is clear.
- Path to a YAML file with a description of led configuration. This file includes definition of robot panels, virtual segments and default animations. + Path to a YAML file with a description of the LED configuration. This file includes the definition of robot panels, virtual segments, and default animations.Tools
LanguageTool
[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### DriverNode This node ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
59-61: Fix punctuation issues and ensure clarity in parameter descriptions.There are punctuation issues in the descriptions of the parameters. Ensure that each description forms a complete sentence and is clear.
- Number of LEDs in a single bumper. + The number of LEDs in a single bumper.panther_manager/README.md (4)
9-9: Minor grammatical improvement: Avoid repetition.The phrase "responsible for launching behavior trees responsible for" is repetitive. Consider rephrasing for clarity.
- `manager_bt.launch.py`: Responsible for launching behavior trees responsible for safety and LED animations scheduling. + `manager_bt.launch.py`: Responsible for launching behavior trees that manage safety and LED animations scheduling.Tools
LanguageTool
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...kage contains: -manager_bt.launch.py: Responsible for launching behavior tree...(UNLIKELY_OPENING_PUNCTUATION)
13-20: Correct punctuation issues.Each item in the list should end with a period for consistency.
- [`lights.xml`](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [`PantherLightsBT.btproj`](./behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panther lights. - [`PantherSafetyBT.btproj`](./behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panther safety protocols. - [`safety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managing dangerous situations. - [`shutdown.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown procedures. - [`lights_manager_config.yaml`](./config/lights_manager_config.yaml): Contains parameters for the `lights_manager` node. - [`safety_manager_config.yaml`](./config/safety_manager_config.yaml): Contains parameters for the `safety_manager` node. - [`shutdown_hosts.yaml`](./config/shutdown_hosts.yaml): List with all hosts to request shutdown. + [`lights.xml`](./behavior_trees/lights.xml): BehaviorTree for managing lights. + [`PantherLightsBT.btproj`](./behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panther lights. + [`PantherSafetyBT.btproj`](./behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panther safety protocols. + [`safety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managing dangerous situations. + [`shutdown.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown procedures. + [`lights_manager_config.yaml`](./config/lights_manager_config.yaml): Contains parameters for the `lights_manager` node. + [`safety_manager_config.yaml`](./config/safety_manager_config.yaml): Contains parameters for the `safety_manager` node. + [`shutdown_hosts.yaml`](./config/shutdown_hosts.yaml): List with all hosts to request shutdown.Tools
LanguageTool
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ights.xml](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [P...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ..../behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...afety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managin...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...own.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...l](./config/lights_manager_config.yaml): Contains parameters for thelights_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...l](./config/safety_manager_config.yaml): Contains parameters for thesafety_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...sts.yaml`](./config/shutdown_hosts.yaml): List with all hosts to request shutdown...(UNLIKELY_OPENING_PUNCTUATION)
24-26: Minor grammatical improvement: Clarify node responsibility.The phrase "Node responsible for managing Bumper Lights animation scheduling" can be improved for clarity.
- Node responsible for managing Bumper Lights animation scheduling. + Node responsible for scheduling Bumper Lights animations.
50-52: Minor grammatical improvement: Clarify node responsibility.The phrase "Node responsible for managing safety features, and software shutdown of components" can be improved for clarity.
- Node responsible for managing safety features, and software shutdown of components. + Node responsible for managing safety features and software shutdown of components.
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (4)
- panther_battery/README.md (1 hunks)
- panther_description/README.md (1 hunks)
- panther_lights/README.md (1 hunks)
- panther_manager/README.md (1 hunks)
Additional context used
LanguageTool
panther_description/README.md
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ponents.yaml`](./config/components.yaml): Allows you to quickly add visualization...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...tor. -WH01.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...H01. -WH02.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...H02. -WH04.yaml: Description of physical and visual para...(UNLIKELY_OPENING_PUNCTUATION)
panther_battery/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...package contains: -battery.launch.py: Responsible for activating battery node...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...default: 0.2]: Specifies timeout in seconds after which driver state messages will ...(AI_HYDRA_LEO_MISSING_COMMA)
panther_lights/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... package contains: -lights.launch.py: Responsible for launching the nodes req...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ..._config.yaml`](./config/led_config.yaml): Defines and describes the appearance an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...rollerNode This node is of type rclcpp_components is responsible for processing animation...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...o a YAML file with a description of the user defined animations. ### DriverNode This node ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~38-~38: Possible missing comma found.
Context: ...DriverNode This node is of type rclcpp_components is responsible for displaying frames on...(AI_HYDRA_LEO_MISSING_COMMA)
panther_manager/README.md
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ...kage contains: -manager_bt.launch.py: Responsible for launching behavior tree...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...ights.xml](./behavior_trees/lights.xml): BehaviorTree for managing lights. - [P...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ..../behavior_trees/PantherLightsBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ..../behavior_trees/PantherSafetyBT.btproj): BehaviorTree project for managing Panth...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...afety.xml`](./behavior_trees/safety.xml): BehaviorTree for monitoring and managin...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...own.xml`](./behavior_trees/shutdown.xml): BehaviorTree for initiating shutdown pr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...l](./config/lights_manager_config.yaml): Contains parameters for thelights_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...l](./config/safety_manager_config.yaml): Contains parameters for thesafety_man...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...sts.yaml`](./config/shutdown_hosts.yaml): List with all hosts to request shutdown...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~84-~84: The singular proper name ‘Ping’ must be used with a third-person or a past tense verb.
Context: ...cess` [bool, default: true]: Ping host until it is not available or timeout is...(HE_VERB_AGR)
* New format of documentation (#369) * Change 3 package for demo * Improve ROS_API * fix links * Update * Update * Table improvements * Format * Save work * Save work * update * fix * fix * fix * fix * fix * Add API warning * Improve links * lights simplify * Create CONFIGURATION.md files * Typos * pre-commit * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Save work * Final unification * Delete trash * typos * Update README.md * Update ROS_API.md * Update ROS_API.md * Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change initial warning to beta warning * improve warn rendering * rendering * Update Diagram * Add Dawid suggestions * Dot * Change diagram ext and typos * Do not describe external nodes * Add Dawid suggestons * Add last Dawid suggestions * Format * Pawel suggestions * Diagram improvements * Update * Diagram Visual --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change scheme theme (#380) * unify CMakeLists.txt files (#381) * First working version * Ros2 increase bt service timeout (#382) * Parametrize and increase service timeout in managers * Format panther API drawio file * Add Estop GUI and docs --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com>
* Implement testing POC * Namespace refactor * Add EStop to Gazebo * unify CMakeLists.txt files * Add dependencies * Add remapping * Rename files in panther_diagnostics package * Update after changes in panther_diagnostics * Rename config and launch file in manager package * Correct include guards in manager package * Restructure files tree in manager tests * Ros2 estop sim gui (#384) * New format of documentation (#369) * Change 3 package for demo * Improve ROS_API * fix links * Update * Update * Table improvements * Format * Save work * Save work * update * fix * fix * fix * fix * fix * Add API warning * Improve links * lights simplify * Create CONFIGURATION.md files * Typos * pre-commit * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Save work * Final unification * Delete trash * typos * Update README.md * Update ROS_API.md * Update ROS_API.md * Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change initial warning to beta warning * improve warn rendering * rendering * Update Diagram * Add Dawid suggestions * Dot * Change diagram ext and typos * Do not describe external nodes * Add Dawid suggestons * Add last Dawid suggestions * Format * Pawel suggestions * Diagram improvements * Update * Diagram Visual --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change scheme theme (#380) * unify CMakeLists.txt files (#381) * First working version * Ros2 increase bt service timeout (#382) * Parametrize and increase service timeout in managers * Format panther API drawio file * Add Estop GUI and docs --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/panther_hardware_plugins.xml Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Add david suggestion and change gui layout * Typos in Readme + estop publish on service call * Reorganize files in panther_lights * UPdate include guards in panther_lights * Reorganize files in panther_battery * Move estop to plugins folder * add nmea gps * Rename battery driver files * Rename shutdown hosts config * Inherit from IgnitionSystem * Change to Estop -> EStop * Reorganize panther_hardware_interfaces files * Dawid suggestions part 1 * Rename PantherSystem -> GzPantherSystem * Update references to files * Rename battery exec * Fix links in documentations (#387) * Refer to header files * Update panther_gazebo/include/panther_gazebo/gz_panther_system.hpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/src/gz_panther_system.cpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/src/gz_panther_system.cpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Dawid suggestions * delete typo * Minor modifications * Move BT plugins to src directory * Reorganize test utilities in hardware_interfaces * Merge remote-tracking branch 'origin/ros2-devel' into ros2-testing-poc * Add missing module configuration * Update panther_gazebo/include/panther_gazebo/gz_panther_system.hpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Dawid suggestions * update docs * Extend filesystem responsibility * Update ROS_API.md Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> * update names * Add new common utility functions * System monitor improvements * Round temperature precision * Implement filesystem unit tests * Formatting * Add integration tests condition * Update ROS_API.md * Review changes * Add pre-commit workflow (#395) --------- Co-authored-by: pawelirh <pawel.irzyk@husarion.com> Co-authored-by: rafal-gorecki <rafal.gorecki@husarion.com> Co-authored-by: Dawid <kmakd197@gmail.com> Co-authored-by: rafal-gorecki <126687345+rafal-gorecki@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com>
* added half tested panther_docking package Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added redme Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * run precommit Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fix typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * After coderabbit review Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * fixed parameters | fixed exporting_package Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Adjust cmake Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added getParameters and declareParameters | review suggestions Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * added offsetPose | moved transformPose to ros_utils Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * removed hardware deps Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Moved TransformPose to tf2_utils Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * added filter description Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * removed realtime_tools Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Modef OffsetFunction utils Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * added and applied ArePosesNear() Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * fix tf utils header guard Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added comment Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added locking node Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docking to develop (#399) * Implement testing POC * Namespace refactor * Add EStop to Gazebo * unify CMakeLists.txt files * Add dependencies * Add remapping * Rename files in panther_diagnostics package * Update after changes in panther_diagnostics * Rename config and launch file in manager package * Correct include guards in manager package * Restructure files tree in manager tests * Ros2 estop sim gui (#384) * New format of documentation (#369) * Change 3 package for demo * Improve ROS_API * fix links * Update * Update * Table improvements * Format * Save work * Save work * update * fix * fix * fix * fix * fix * Add API warning * Improve links * lights simplify * Create CONFIGURATION.md files * Typos * pre-commit * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Save work * Final unification * Delete trash * typos * Update README.md * Update ROS_API.md * Update ROS_API.md * Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change initial warning to beta warning * improve warn rendering * rendering * Update Diagram * Add Dawid suggestions * Dot * Change diagram ext and typos * Do not describe external nodes * Add Dawid suggestons * Add last Dawid suggestions * Format * Pawel suggestions * Diagram improvements * Update * Diagram Visual --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Change scheme theme (#380) * unify CMakeLists.txt files (#381) * First working version * Ros2 increase bt service timeout (#382) * Parametrize and increase service timeout in managers * Format panther API drawio file * Add Estop GUI and docs --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/panther_hardware_plugins.xml Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Add david suggestion and change gui layout * Typos in Readme + estop publish on service call * Reorganize files in panther_lights * UPdate include guards in panther_lights * Reorganize files in panther_battery * Move estop to plugins folder * add nmea gps * Rename battery driver files * Rename shutdown hosts config * Inherit from IgnitionSystem * Change to Estop -> EStop * Reorganize panther_hardware_interfaces files * Dawid suggestions part 1 * Rename PantherSystem -> GzPantherSystem * Update references to files * Rename battery exec * Fix links in documentations (#387) * Refer to header files * Update panther_gazebo/include/panther_gazebo/gz_panther_system.hpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/src/gz_panther_system.cpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Update panther_gazebo/src/gz_panther_system.cpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Dawid suggestions * delete typo * Minor modifications * Move BT plugins to src directory * Reorganize test utilities in hardware_interfaces * Merge remote-tracking branch 'origin/ros2-devel' into ros2-testing-poc * Add missing module configuration * Update panther_gazebo/include/panther_gazebo/gz_panther_system.hpp Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * Dawid suggestions * update docs * Extend filesystem responsibility * Update ROS_API.md Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> * update names * Add new common utility functions * System monitor improvements * Round temperature precision * Implement filesystem unit tests * Formatting * Add integration tests condition * Update ROS_API.md * Review changes * Add pre-commit workflow (#395) --------- Co-authored-by: pawelirh <pawel.irzyk@husarion.com> Co-authored-by: rafal-gorecki <rafal.gorecki@husarion.com> Co-authored-by: Dawid <kmakd197@gmail.com> Co-authored-by: rafal-gorecki <126687345+rafal-gorecki@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com> * ROS2 docking manager plugins (#394) * Added base of BT docking plugins Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Teste dock and undock plugins Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed test dock manager Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * run precommit Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * moved plugins Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * changed names of files and classes | changed DockRobotAction to DockRobot Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed copyright Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed timeouts | changed using Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * JoySubscription BT node (#397) * changed main in manager's tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed to AreButtonsPressed Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed model Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Revert "Fixed model" This reverts commit 97d85c2. * Fixed model Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Readme update Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update panther_docking/README.md Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> * Added exec depend and pip install to cmake Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * add python as interpreter Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed namespaces and updated ros_component_description (#424) * Fixed namespaces and updated ros_component_description Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Remove panther_version --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> Co-authored-by: rafal-gorecki <rafal.gorecki@husarion.com> * Ros2 docking manager no lights (#430) * Manage lights * Simple working version * Clean up * Clean up and add types enums * Simplifications * Change ports * Add use_docking arg * Fix port * Fix port * Add more cases to tests * update * Fix ports * Add dock_pose field, improve description, add dependencies * Docking manager without lights * Auto review * Update CONFIGURATION.md * Typo * Coderabbit suggestions * Jakub suggestions * Fix tests * Jakub suggestions * ROS2 docking fix joy (#439) * Fixed utils test, fixed joy Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Revert "Fixed utils test, fixed joy" This reverts commit 3bd5e30. * Fixed bt utils test, changed dock jot input Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Joy input and typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Charging Dock Plugin based on dock pose subscriber (#431) * Fixed namespaces and updated ros_component_description Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed GetDockPose approach Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Cleanup charger Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added unit tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs: Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fix upside down Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added updateAndPublishStagingPose method Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added suggestins | added reading docking_server parameter is dock pose publisher Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Remove redundant tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added aprilros launch to simulation Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * update vsc and changed dock name Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Ros2 docking charging dock wibotic msgs (#436) * Fixed namespaces and updated ros_component_description Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed GetDockPose approach Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Cleanup charger Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added unit tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs: Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fix upside down Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added updateAndPublishStagingPose method Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added suggestins | added reading docking_server parameter is dock pose publisher Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Remove redundant tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added reading wibotic_info Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added launching wibotic_connector_can Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added right condition to wibotic_connector_can Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * wibotic_ros is needed to build Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update repose, update parameters Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added condition for use_docking Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * update repose Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed use_wibotic_info param Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Rafal's suggestions applied Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * README update and comment delete Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update .repose Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * ROS2 docking nav2 (#443) * Fixed namespaces and updated ros_component_description Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed GetDockPose approach Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Cleanup charger Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added unit tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs: Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fix upside down Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added updateAndPublishStagingPose method Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added suggestins | added reading docking_server parameter is dock pose publisher Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Remove redundant tests Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added aprilros launch to simulation Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * update vsc and changed dock name Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Tested with nav2 in simulation | Added docking to multibple stations | Spawning multiple stations Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed after merge Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * described parameters | applied codeguides Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * coderabbitai suggestions Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Review Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * wibotic_connector_ros depends on hardware | fixed launch args Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * wibotic_connector_ros depends on hardware | fixed launch args Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added default values Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update panther_manager/launch/manager.launch.py --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> Co-authored-by: Rafal Gorecki <126687345+rafal-gorecki@users.noreply.github.com> * Ros2 docking tf compare (#451) * Changed camera pose Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed test Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update panther_docking/README.md Co-authored-by: Rafal Gorecki <126687345+rafal-gorecki@users.noreply.github.com> * updated vcs Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> Co-authored-by: Rafal Gorecki <126687345+rafal-gorecki@users.noreply.github.com> * Ros2 docking lifecycle node (#453) * Changed camera pose Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed test Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Update docs Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * typo Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed to lifecyclenode | added transition service client Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Updated docs Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Added timeout function Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Changed names in package Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Revert "Changed names in package" This reverts commit 31ae7ce. * ROS2 Docking - panther_docking to husarion_ugv_docking (#459) * Changed names in package Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * fixed param name Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed docking Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed docking manager Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed docking manager Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed after merge Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Code rabbit ai suggestions Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Remove accident panther_manager Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed dock plugins Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed path Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed path Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed path Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed docking files Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Removed tf2_utils Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * removed station launch Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> * Fixed HEADER GUARD Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> --------- Signed-off-by: Jakub Delicat <jakub.delicat@husarion.com> Co-authored-by: pawelirh <pawel.irzyk@husarion.com> Co-authored-by: rafal-gorecki <rafal.gorecki@husarion.com> Co-authored-by: Dawid <kmakd197@gmail.com> Co-authored-by: rafal-gorecki <126687345+rafal-gorecki@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Paweł Irzyk <108666440+pawelirh@users.noreply.github.com> Co-authored-by: Dawid Kmak <73443304+KmakD@users.noreply.github.com>
Description
pkg/CONFIGURATION.mdfiles containing usefull not default options (e.g. Wheel Spaw, GPS integration with simulation, add custom animations).shutdown_hosts.yamlfrom panther_bringup -> panther_managerSummary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
Documentation