Added a documentation of the SimulationInterfaces gem#2652
Added a documentation of the SimulationInterfaces gem#2652ShaunaGordon merged 6 commits intoo3de:developmentfrom
Conversation
ShaunaGordon
left a comment
ShaunaGordon
left a comment
There was a problem hiding this comment.
Just the one minor thing. Looks good otherwise.
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
Signed-off-by: Patryk Antosz <patryk.antosz@robotec.ai>
Signed-off-by: Patryk Antosz <patryk.antosz@robotec.ai>
Signed-off-by: Jan Hanca <jan.hanca@robotec.ai>
Signed-off-by: Michał Pełka <michal.pelka@robotec.ai>
michalpelka
force-pushed
the
pantosz/simulation_interfaces
branch
from
c91df90 to
b5ce0a8
Compare
|
@ShaunaGordon , I've rebased on top of #2651 and force pushed. |
* Update sample projects and templates * Update robotics content * Added a documentation of the SimulationInterfaces gem * Applied review suggestions * Code review changes (#4) * Michal's changes --------- Signed-off-by: Jan Hanca <jan.hanca@robotec.ai> Signed-off-by: Patryk Antosz <patryk.antosz@robotec.ai> Signed-off-by: Michał Pełka <michal.pelka@robotec.ai> Co-authored-by: Jan Hanca <jan.hanca@robotec.ai> Co-authored-by: Michał Pełka <michal.pelka@robotec.ai>
arturkamieniecki
left a comment
arturkamieniecki
left a comment
There was a problem hiding this comment.
Please verify the weight parameters, as in some files the value is 120 and in others 300, 220 etc.
The most promenent comment is about \ as line break. There are more instances of this that are not marked. Please apply all changes of these comments to all other instances of \ used as line break.
Overall the text is clean and reads nicely.
Note: I have not verified if all links in these files point to a correct location.
| | [Vehicle Dynamics](vehicle-dynamics.md) | Drive your robot with skid steering or Ackermann drive models. | | ||
| | [Joints Manipulation](joints-manipulation.md) | Control robotic manipulators and joints. | |
There was a problem hiding this comment.
The | characters are unaligned.
| 1. Some sensors are already implemented in this Gem. | ||
| 1. They might require specialization (implementation specific for particular models). | ||
| 2. You might like to consider tradeoffs between performance and realism in each case. | ||
| 2. You might like to consider trade-offs between performance and realism in each case. |
There was a problem hiding this comment.
Both spellings are correct, but the tradeoffs spelling less common in British English.
| - [Georeferencing Gem](georeference.md), a helper Gem enabling simulated robots to use global positioning devices and geo-reference APIs. | ||
| - Asset Gems providing sample ROS 2 prefabs (robots) and scene decorations, including: | ||
| - [ROS 2 Sample Robots Gem](https://github.com/o3de/o3de-extras/tree/main/Gems/ROS2SampleRobots) providing assets of `ProteusRobot`, `ROSBot XL`, and `Panda Franka` robots. | ||
| - [WarehouseAssets](https://github.com/o3de/o3de-extras/tree/main/Gems/WarehouseAssets) and [WarehouseAutomation](https://github.com/o3de/o3de-extras/tree/main/Gems/WarehouseAutomation) Gems providing useful assets for warehouse environments |
| ROS 2 _service_ definition: [GetEntityState.srv](https://github.com/ros-simulation/simulation_interfaces/tree/main/srv/GetSimulatorFeatures.srv) \ | ||
| SimulatorFeatures definition: [SimulatorFeatures](https://github.com/ros-simulation/simulation_interfaces/tree/main/msg/SimulatorFeatures.msg) \ | ||
| Default _service_ name: `/get_simulation_features` \ |
There was a problem hiding this comment.
On https://www.markdownguide.org/basic-syntax/#line-break-best-practices it says that \ should not be used as a line break. Instead double spaces should be used.
| ROS 2 _service_ definition: [GetSpawnables](https://github.com/ros-simulation/simulation_interfaces/tree/main/srv/GetSpawnables.srv) \ | ||
| Individual _spawnables_ ROS 2 _message_ definition: [Spawnable.msg](https://github.com/ros-simulation/simulation_interfaces/tree/main/msg/Spawnable.msg) \ | ||
| Default _service_ name: `/get_spawnables` \ |
There was a problem hiding this comment.
On https://www.markdownguide.org/basic-syntax/#line-break-best-practices it says that \ should not be used as a line break. Instead double spaces should be used.
| ROS 2 _service_ definition: [SpawnEntity](https://github.com/ros-simulation/simulation_interfaces/tree/main/srv/SpawnEntity.srv) \ | ||
| Default _service_ name: `/spawn_entity` \ |
There was a problem hiding this comment.
On https://www.markdownguide.org/basic-syntax/#line-break-best-practices it says that \ should not be used as a line break. Instead double spaces should be used.
| ROS 2 _service_ definition: [GetEntities](https://github.com/ros-simulation/simulation_interfaces/tree/main/srv/GetEntities.srv) \ | ||
| EntityFilters definition: [EntityFilters](https://github.com/ros-simulation/simulation_interfaces/blob/main/msg/EntityFilters.msg) \ | ||
| Default _service_ name: `/get_entities` \ |
There was a problem hiding this comment.
On https://www.markdownguide.org/basic-syntax/#line-break-best-practices it says that \ should not be used as a line break. Instead double spaces should be used.
5 participants
Change summary
This PR adds the description of the O3DE implementation of the simulation_interfaces standard.