-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix absolute links #385
Fix absolute links #385
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -23,7 +23,7 @@ Package that implements SystemInterface from ros2_control for Panther. | |||||
[//]: # (ROS_API_NODE_DESCRIPTION_START) | ||||||
|
||||||
This package doesn't contain any standalone nodes - `PantherSystem` is a plugin loaded by the resource manager. | ||||||
To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](https://github.com/husarion/panther_ros/panther_description/)) and add a controller (example configuration provided in [panther_controller](https://github.com/husarion/panther_ros/panther_controller/) package). | ||||||
To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description)) and add a controller (example configuration provided in [panther_controller](../panther_controller) package). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add missing comma. A comma is needed after "That said" for clarity. - That said apart from the usual interface provided by the ros2_control, this plugin also provides additional published topics and services specific for Panther.
+ That said, apart from the usual interface provided by the ros2_control, this plugin also provides additional published topics and services specific for Panther.
ToolsLanguageTool
|
||||||
That said apart from the usual interface provided by the ros2_control, this plugin also provides additional published topics and services specific for Panther. | ||||||
|
||||||
[//]: # (ROS_API_NODE_DESCRIPTION_END) | ||||||
|
@@ -58,7 +58,7 @@ That said apart from the usual interface provided by the ros2_control, this plug | |||||
|
||||||
[//]: # (ROS_API_NODE_PARAMETERS_START) | ||||||
|
||||||
Parameters that are required, are defined when including interface in URDF (you can check out [panther_macro.urdf.xacro](https://github.com/husarion/panther_ros/panther_description/urdf/panther_macro.urdf.xacro)). | ||||||
Parameters that are required, are defined when including interface in URDF (you can check out [panther_macro.urdf.xacro](../panther_description/urdf/panther_macro.urdf.xacro)). | ||||||
|
||||||
Physical properties | ||||||
|
||||||
|
@@ -71,9 +71,9 @@ Physical properties | |||||
CAN settings | ||||||
|
||||||
- `can_interface_name` [*string*, default: **panther_can**]: name of the CAN interface. | ||||||
- `master_can_id` [*int*, default: **3**]: CAN ID of the master device (set as in [canopen_configuration.yaml](https://github.com/husarion/panther_ros/panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `front_driver_can_id` [*int*, default: **1**]: CAN ID defined in the properties of Roboteq (set as in [canopen_configuration.yaml](https://github.com/husarion/panther_ros/panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `rear_driver_can_id` [*int*, default: **2**]: CAN ID defined in the properties of Roboteq (set as in [canopen_configuration.yaml](https://github.com/husarion/panther_ros/panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `master_can_id` [*int*, default: **3**]: CAN ID of the master device (set as in [canopen_configuration.yaml](../panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `front_driver_can_id` [*int*, default: **1**]: CAN ID defined in the properties of Roboteq (set as in [canopen_configuration.yaml](../panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `rear_driver_can_id` [*int*, default: **2**]: CAN ID defined in the properties of Roboteq (set as in [canopen_configuration.yaml](../panther_hardware_interfaces/config/canopen_configuration.yaml)). | ||||||
- `sdo_operation_timeout_ms` [*int*, default: **100**]: timeout of the SDO operations, currently no SDO operation is required in RT operation, so this timeout can be set to a higher value. | ||||||
- `pdo_motor_states_timeout_ms` [*int*, default: **15**]: depends on the frequency at which Roboteq is configured to send motor states (PDO 1 and 2) data. By default, there should be 10 **[ms]** between received data, if it takes more than `pdo_motor_states_timeout_ms`, a motor states read error is triggered. The default value is set to be expected period +50% margin. | ||||||
- `pdo_driver_state_timeout_ms` [*int*, default: **75**]: depends on the frequency at which Roboteq is configured to send driver state (PDO 3 and 4) data. By default, there should be 50 **[ms]** between received data, if it takes more than `pdo_driver_state_timeout_ms`, a driver state read error is triggered. The default value is set to be expected period +50% margin. | ||||||
|
@@ -98,15 +98,15 @@ CAN settings | |||||
[//]: # (ROS_API_NODE_DESCRIPTION_START) | ||||||
|
||||||
This package doesn't contain any standalone nodes - `PantherImuSensor` is a plugin loaded by the resource manager. | ||||||
To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](https://github.com/husarion/panther_ros/tree/ros2-devel/panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](https://github.com/husarion/panther_ros/tree/ros2-devel/panther_controller/) package). | ||||||
To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package). | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add missing comma. A comma is needed after "To use this hardware interface" for clarity. - To use this hardware interface you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package).
+ To use this hardware interface, you have to add it to your URDF (you can check how to do it in [panther_description](../panther_description/)) and add an `imu_sensor_broadcaster` controller (example configuration provided in [panther_controller](../panther_controller/) package). Committable suggestion
Suggested change
ToolsLanguageTool
|
||||||
|
||||||
[//]: # (ROS_API_NODE_DESCRIPTION_END) | ||||||
|
||||||
#### Parameters | ||||||
|
||||||
[//]: # (ROS_API_NODE_PARAMETERS_START) | ||||||
|
||||||
Parameters that are required, are defined when including interface in URDF (you can check out [panther_macro.urdf.xacro](https://github.com/husarion/panther_ros/tree/ros2-devel/panther_description/urdf/panther_macro.urdf.xacro)). | ||||||
Parameters that are required, are defined when including interface in URDF (you can check out [panther_macro.urdf.xacro](../panther_description/urdf/panther_macro.urdf.xacro)). | ||||||
|
||||||
Physical properties | ||||||
|
||||||
|
@@ -170,7 +170,7 @@ zeta = sqrt(3/4)* gyroMeasDrift = 0.00151 | |||||
|
||||||
## Code structure | ||||||
|
||||||
The code structure is described in more detail in a [separate file](https://github.com/husarion/panther_ros/panther_hardware_interfaces/CODE_STRUCTURE.md). | ||||||
The code structure is described in more detail in a [separate file](../panther_hardware_interfaces/CODE_STRUCTURE.md). | ||||||
|
||||||
## Generating CAN config | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -160,15 +160,15 @@ Default animations can be found in the table below: | |||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
| ID | NAME | PRIORITY | ANIMATION | | ||||||||||||||||||||||||||||||||||||||
| :---: | ----------------- | :------: | --------------------------------------------------------------------------------------------------------------------- | | ||||||||||||||||||||||||||||||||||||||
| 0 | E_STOP | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/E_STOP.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 1 | READY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/READY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 2 | ERROR | 1 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/ERROR.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 3 | MANUAL_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/MANUAL_ACTION.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 4 | AUTONOMOUS_ACTION | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 5 | GOAL_ACHIEVED | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 6 | LOW_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/LOW_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 7 | CRITICAL_BATTERY | 2 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 9 | CHARGING_BATTERY | 3 | <img src="https://github.com/husarion/panther_ros/blob/ros2/panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
| 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> | | ||||||||||||||||||||||||||||||||||||||
Comment on lines
+163
to
+171
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add alt text to images. The images in the table lack alt text, which is important for accessibility. - | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400"> |
+ | 0 | E_STOP | 3 | <img src="../panther_lights/.docs/E_STOP.webp" width="400" alt="E_STOP"> |
- | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400"> |
+ | 1 | READY | 3 | <img src="../panther_lights/.docs/READY.webp" width="400" alt="READY"> |
- | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400"> |
+ | 2 | ERROR | 1 | <img src="../panther_lights/.docs/ERROR.webp" width="400" alt="ERROR"> |
- | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400"> |
+ | 3 | MANUAL_ACTION | 3 | <img src="../panther_lights/.docs/MANUAL_ACTION.webp" width="400" alt="MANUAL_ACTION"> |
- | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400"> |
+ | 4 | AUTONOMOUS_ACTION | 3 | <img src="../panther_lights/.docs/AUTONOMOUS_ACTION.webp" width="400" alt="AUTONOMOUS_ACTION"> |
- | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400"> |
+ | 5 | GOAL_ACHIEVED | 2 | <img src="../panther_lights/.docs/GOAL_ACHIEVED.webp" width="400" alt="GOAL_ACHIEVED"> |
- | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400"> |
+ | 6 | LOW_BATTERY | 2 | <img src="../panther_lights/.docs/LOW_BATTERY.webp" width="400" alt="LOW_BATTERY"> |
- | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400"> |
+ | 7 | CRITICAL_BATTERY | 2 | <img src="../panther_lights/.docs/CRITICAL_BATTERY.webp" width="400" alt="CRITICAL_BATTERY"> |
- | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400"> |
+ | 9 | CHARGING_BATTERY | 3 | <img src="../panther_lights/.docs/CHARGING_BATTERY.webp" width="400" alt="CHARGING_BATTERY"> | Committable suggestion
Suggested change
ToolsMarkdownlint
|
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
### Animation Types | ||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add missing article "the".
The sentence "It is possible to change Panther wheels model in simulation." is missing the article "the" before "Panther wheels model."
Committable suggestion
Tools
LanguageTool