Skip to content
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

Add documentation for manipulation area #80

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

afr2903
Copy link
Member

@afr2903 afr2903 commented Nov 21, 2024

Fixes #79

Add documentation for various ROS nodes and services in the cartesian_movement_services, frida_arm_joints_server, object_detector_3d, and pick_and_place packages.

  • cartesian_movement_services package:

    • Add docstrings and comments to arm_movements.py, cartesian_client.py, and cartesian_server.py.
    • Add examples and use cases for key technologies used in arm_movements.py, cartesian_client.py, and cartesian_server.py.
  • frida_arm_joints_server package:

    • Add docstrings and comments to arm_joint_server.py.
    • Add examples and use cases for key technologies used in arm_joint_server.py.
  • object_detector_3d package:

    • Add docstrings and comments to Clustering_Server.py.
    • Add examples and use cases for key technologies used in Clustering_Server.py.
  • pick_and_place package:

    • Add docstrings and comments to cartesianManipulationServer.py, getState.py, manipulationCaller.py, manipulationClient.py, and manipulationServer.py.
    • Add examples and use cases for key technologies used in cartesianManipulationServer.py, getState.py, manipulationCaller.py, manipulationClient.py, and manipulationServer.py.
  • pouring_services package:

    • Add docstrings and comments to pouring_srv.py.
    • Add examples and use cases for key technologies used in pouring_srv.py.
  • README.md file:

    • Add sections for the purpose of the area in the service robot, technologies used in each ROS node, and examples and use cases.

For more details, open the Copilot Workspace session.

Fixes #79

Add documentation for various ROS nodes and services in the `cartesian_movement_services`, `frida_arm_joints_server`, `object_detector_3d`, and `pick_and_place` packages.

* **`cartesian_movement_services` package:**
  - Add docstrings and comments to `arm_movements.py`, `cartesian_client.py`, and `cartesian_server.py`.
  - Add examples and use cases for key technologies used in `arm_movements.py`, `cartesian_client.py`, and `cartesian_server.py`.

* **`frida_arm_joints_server` package:**
  - Add docstrings and comments to `arm_joint_server.py`.
  - Add examples and use cases for key technologies used in `arm_joint_server.py`.

* **`object_detector_3d` package:**
  - Add docstrings and comments to `Clustering_Server.py`.
  - Add examples and use cases for key technologies used in `Clustering_Server.py`.

* **`pick_and_place` package:**
  - Add docstrings and comments to `cartesianManipulationServer.py`, `getState.py`, `manipulationCaller.py`, `manipulationClient.py`, and `manipulationServer.py`.
  - Add examples and use cases for key technologies used in `cartesianManipulationServer.py`, `getState.py`, `manipulationCaller.py`, `manipulationClient.py`, and `manipulationServer.py`.

* **`pouring_services` package:**
  - Add docstrings and comments to `pouring_srv.py`.
  - Add examples and use cases for key technologies used in `pouring_srv.py`.

* **`README.md` file:**
  - Add sections for the purpose of the area in the service robot, technologies used in each ROS node, and examples and use cases.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/RoBorregos/home-manipulation/issues/79?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation of current state 2024
1 participant