diff --git a/robotics-ai-suite/docs/rvc b/robotics-ai-suite/docs/rvc deleted file mode 120000 index 8f9e4f9796..0000000000 --- a/robotics-ai-suite/docs/rvc +++ /dev/null @@ -1 +0,0 @@ -../robot-vision-control/docs/source \ No newline at end of file diff --git a/robotics-ai-suite/robot-vision-control/docs/source/Dockerfile b/robotics-ai-suite/docs/rvc/Dockerfile similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/Dockerfile rename to robotics-ai-suite/docs/rvc/Dockerfile diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components.rst b/robotics-ai-suite/docs/rvc/components.rst similarity index 92% rename from robotics-ai-suite/robot-vision-control/docs/source/components.rst rename to robotics-ai-suite/docs/rvc/components.rst index e8ed91f0c5..61b657170d 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/components.rst +++ b/robotics-ai-suite/docs/rvc/components.rst @@ -15,7 +15,7 @@ RVC Framework is composed by High level design: -.. image:: images/html/RVC.png +.. image:: ./images/html/RVC.png .. toctree:: :maxdepth: 1 diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/images b/robotics-ai-suite/docs/rvc/components/images similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/images rename to robotics-ai-suite/docs/rvc/components/images diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_api.rst b/robotics-ai-suite/docs/rvc/components/rvc_api.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_api.rst rename to robotics-ai-suite/docs/rvc/components/rvc_api.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control.rst b/robotics-ai-suite/docs/rvc/components/rvc_control.rst similarity index 96% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control.rst rename to robotics-ai-suite/docs/rvc/components/rvc_control.rst index 20e17964be..7875a2c018 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control.rst +++ b/robotics-ai-suite/docs/rvc/components/rvc_control.rst @@ -6,7 +6,7 @@ Control .. _High Level Design: -.. image:: images/html/RVCControl.png +.. image:: ../../images/html/RVCControl.png :alt: High Level Design The above :ref:`High Level Design ` diagram shows in communication between diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/grasp_plugin.rst b/robotics-ai-suite/docs/rvc/components/rvc_control/grasp_plugin.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/grasp_plugin.rst rename to robotics-ai-suite/docs/rvc/components/rvc_control/grasp_plugin.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/motion_controller_plugin.rst b/robotics-ai-suite/docs/rvc/components/rvc_control/motion_controller_plugin.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/motion_controller_plugin.rst rename to robotics-ai-suite/docs/rvc/components/rvc_control/motion_controller_plugin.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/parameters.rst b/robotics-ai-suite/docs/rvc/components/rvc_control/parameters.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_control/parameters.rst rename to robotics-ai-suite/docs/rvc/components/rvc_control/parameters.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/2.5d_vision/2.5d_vision.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/2.5d_vision/2.5d_vision.rst similarity index 96% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/2.5d_vision/2.5d_vision.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/2.5d_vision/2.5d_vision.rst index a960d56d2c..f580607a43 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/2.5d_vision/2.5d_vision.rst +++ b/robotics-ai-suite/docs/rvc/components/rvc_vision/2.5d_vision/2.5d_vision.rst @@ -12,7 +12,7 @@ This approach uses a standard camera RGB steam together with the camera calibrat With Computer Vision methods, the camera stream is scanned for given objects (by sample image). A detection is in the form of a 2D bounding box with an additional angle defining the rotation of the object. -.. image:: ../../../images/html/rotatedBB.png +.. image:: ./../../../../images/html/rotatedBB.png .. note:: @@ -31,7 +31,7 @@ Pose Projection Additionally, this component is capable of projecting the finding in the flat RGB input image into a 3D object pose. Therefor the algorithm projects the object found in the 2D image onto a plane at the given distance and assumes that the object from the image is located on this plane. -.. image:: ../../../images/html/PoseProjection.png +.. image:: ../../../../../images/html/PoseProjection.png The above illustration shows the setup and how the camera, the plana and the object relate to each other. @@ -40,7 +40,7 @@ This will be the input for the :ref:`Control` components to define Annotated image ^^^^^^^^^^^^^^^ -.. image:: ../../../images/html/2.5DAnnotatedImage.png +.. image:: ../../../../../images/html/2.5DAnnotatedImage.png The ``rotated_object_detection`` node can produce an annotated image as output. This is useful to visually inspect the detections. diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/2.5d_vision/images b/robotics-ai-suite/docs/rvc/components/rvc_vision/2.5d_vision/images similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/2.5d_vision/images rename to robotics-ai-suite/docs/rvc/components/rvc_vision/2.5d_vision/images diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision.rst similarity index 96% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision.rst index 1378bb32f1..f302da0452 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision.rst +++ b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision.rst @@ -24,7 +24,7 @@ The component of this container are: .. _vision_container_high_level_diagram: -.. image:: images/html/RVCVisionHighLevel.png +.. image:: ../../../images/html/RVCVisionHighLevel.png :alt: Vision container high level diagram diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/object_detection.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/object_detection.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/object_detection.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/object_detection.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/pose_detector.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/pose_detector.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/pose_detector.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/pose_detector.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/profiler.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/profiler.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/profiler.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/profiler.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/realsense_node.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/realsense_node.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/dynamic_vision/realsense_node.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/dynamic_vision/realsense_node.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/images b/robotics-ai-suite/docs/rvc/components/rvc_vision/images similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/images rename to robotics-ai-suite/docs/rvc/components/rvc_vision/images diff --git a/robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/rvc_vision_messages.rst b/robotics-ai-suite/docs/rvc/components/rvc_vision/rvc_vision_messages.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/components/rvc_vision/rvc_vision_messages.rst rename to robotics-ai-suite/docs/rvc/components/rvc_vision/rvc_vision_messages.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/conf.py b/robotics-ai-suite/docs/rvc/conf.py similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/conf.py rename to robotics-ai-suite/docs/rvc/conf.py diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development.rst b/robotics-ai-suite/docs/rvc/development.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development.rst rename to robotics-ai-suite/docs/rvc/development.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/api.rst b/robotics-ai-suite/docs/rvc/development/api.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/api.rst rename to robotics-ai-suite/docs/rvc/development/api.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/main_application.rst b/robotics-ai-suite/docs/rvc/development/main_application.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/main_application.rst rename to robotics-ai-suite/docs/rvc/development/main_application.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/modify_hardware_setup.rst b/robotics-ai-suite/docs/rvc/development/modify_hardware_setup.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/modify_hardware_setup.rst rename to robotics-ai-suite/docs/rvc/development/modify_hardware_setup.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control.rst b/robotics-ai-suite/docs/rvc/development/rvc_control.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control.rst rename to robotics-ai-suite/docs/rvc/development/rvc_control.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/grasp_interface.rst b/robotics-ai-suite/docs/rvc/development/rvc_control/grasp_interface.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/grasp_interface.rst rename to robotics-ai-suite/docs/rvc/development/rvc_control/grasp_interface.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/motion_controller_interface.md b/robotics-ai-suite/docs/rvc/development/rvc_control/motion_controller_interface.md similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/motion_controller_interface.md rename to robotics-ai-suite/docs/rvc/development/rvc_control/motion_controller_interface.md diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/rvc_interface_apis/interface_apis.rst b/robotics-ai-suite/docs/rvc/development/rvc_control/rvc_interface_apis/interface_apis.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_control/rvc_interface_apis/interface_apis.rst rename to robotics-ai-suite/docs/rvc/development/rvc_control/rvc_interface_apis/interface_apis.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_vision.rst b/robotics-ai-suite/docs/rvc/development/rvc_vision.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_vision.rst rename to robotics-ai-suite/docs/rvc/development/rvc_vision.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/development/rvc_vision/rvc_vision_api.rst b/robotics-ai-suite/docs/rvc/development/rvc_vision/rvc_vision_api.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/development/rvc_vision/rvc_vision_api.rst rename to robotics-ai-suite/docs/rvc/development/rvc_vision/rvc_vision_api.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/extensions/last_updated.py b/robotics-ai-suite/docs/rvc/extensions/last_updated.py similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/extensions/last_updated.py rename to robotics-ai-suite/docs/rvc/extensions/last_updated.py diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted.rst b/robotics-ai-suite/docs/rvc/getstarted.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted.rst rename to robotics-ai-suite/docs/rvc/getstarted.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/camera_setup.rst b/robotics-ai-suite/docs/rvc/getstarted/camera_setup.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/camera_setup.rst rename to robotics-ai-suite/docs/rvc/getstarted/camera_setup.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_success.png b/robotics-ai-suite/docs/rvc/getstarted/images/firmware_success.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_success.png rename to robotics-ai-suite/docs/rvc/getstarted/images/firmware_success.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_update_request.png b/robotics-ai-suite/docs/rvc/getstarted/images/firmware_update_request.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_update_request.png rename to robotics-ai-suite/docs/rvc/getstarted/images/firmware_update_request.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_updating.png b/robotics-ai-suite/docs/rvc/getstarted/images/firmware_updating.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/images/firmware_updating.png rename to robotics-ai-suite/docs/rvc/getstarted/images/firmware_updating.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/install.rst b/robotics-ai-suite/docs/rvc/getstarted/install.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/install.rst rename to robotics-ai-suite/docs/rvc/getstarted/install.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/prepare_system.md b/robotics-ai-suite/docs/rvc/getstarted/prepare_system.md similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/prepare_system.md rename to robotics-ai-suite/docs/rvc/getstarted/prepare_system.md diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/requirements.rst b/robotics-ai-suite/docs/rvc/getstarted/requirements.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/requirements.rst rename to robotics-ai-suite/docs/rvc/getstarted/requirements.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/getstarted/supported_hw.rst b/robotics-ai-suite/docs/rvc/getstarted/supported_hw.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/getstarted/supported_hw.rst rename to robotics-ai-suite/docs/rvc/getstarted/supported_hw.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/2.5DAnnotatedImage.png b/robotics-ai-suite/docs/rvc/images/html/2.5DAnnotatedImage.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/2.5DAnnotatedImage.png rename to robotics-ai-suite/docs/rvc/images/html/2.5DAnnotatedImage.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/CenteredObject.png b/robotics-ai-suite/docs/rvc/images/html/CenteredObject.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/CenteredObject.png rename to robotics-ai-suite/docs/rvc/images/html/CenteredObject.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/PoseProjection.png b/robotics-ai-suite/docs/rvc/images/html/PoseProjection.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/PoseProjection.png rename to robotics-ai-suite/docs/rvc/images/html/PoseProjection.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/RVC.png b/robotics-ai-suite/docs/rvc/images/html/RVC.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/RVC.png rename to robotics-ai-suite/docs/rvc/images/html/RVC.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/RVCControl.png b/robotics-ai-suite/docs/rvc/images/html/RVCControl.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/RVCControl.png rename to robotics-ai-suite/docs/rvc/images/html/RVCControl.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/RVCVisionHighLevel.png b/robotics-ai-suite/docs/rvc/images/html/RVCVisionHighLevel.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/RVCVisionHighLevel.png rename to robotics-ai-suite/docs/rvc/images/html/RVCVisionHighLevel.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/RobotBackground.png b/robotics-ai-suite/docs/rvc/images/html/RobotBackground.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/RobotBackground.png rename to robotics-ai-suite/docs/rvc/images/html/RobotBackground.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/RvizDynamicUseCase1.png b/robotics-ai-suite/docs/rvc/images/html/RvizDynamicUseCase1.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/RvizDynamicUseCase1.png rename to robotics-ai-suite/docs/rvc/images/html/RvizDynamicUseCase1.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/TCPOffset.png b/robotics-ai-suite/docs/rvc/images/html/TCPOffset.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/TCPOffset.png rename to robotics-ai-suite/docs/rvc/images/html/TCPOffset.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/URCreateProgram.png b/robotics-ai-suite/docs/rvc/images/html/URCreateProgram.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/URCreateProgram.png rename to robotics-ai-suite/docs/rvc/images/html/URCreateProgram.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/URExternalControl.png b/robotics-ai-suite/docs/rvc/images/html/URExternalControl.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/URExternalControl.png rename to robotics-ai-suite/docs/rvc/images/html/URExternalControl.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/URRobotiqGripper.png b/robotics-ai-suite/docs/rvc/images/html/URRobotiqGripper.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/URRobotiqGripper.png rename to robotics-ai-suite/docs/rvc/images/html/URRobotiqGripper.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/YoloDetection.png b/robotics-ai-suite/docs/rvc/images/html/YoloDetection.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/YoloDetection.png rename to robotics-ai-suite/docs/rvc/images/html/YoloDetection.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/checklist_robot.png b/robotics-ai-suite/docs/rvc/images/html/checklist_robot.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/checklist_robot.png rename to robotics-ai-suite/docs/rvc/images/html/checklist_robot.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/convertWaypoint.png b/robotics-ai-suite/docs/rvc/images/html/convertWaypoint.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/convertWaypoint.png rename to robotics-ai-suite/docs/rvc/images/html/convertWaypoint.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/editObject.png b/robotics-ai-suite/docs/rvc/images/html/editObject.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/editObject.png rename to robotics-ai-suite/docs/rvc/images/html/editObject.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/exportToObj.png b/robotics-ai-suite/docs/rvc/images/html/exportToObj.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/exportToObj.png rename to robotics-ai-suite/docs/rvc/images/html/exportToObj.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/homeposition.png b/robotics-ai-suite/docs/rvc/images/html/homeposition.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/homeposition.png rename to robotics-ai-suite/docs/rvc/images/html/homeposition.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/importSTL.png b/robotics-ai-suite/docs/rvc/images/html/importSTL.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/importSTL.png rename to robotics-ai-suite/docs/rvc/images/html/importSTL.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/pcl_viewer.png b/robotics-ai-suite/docs/rvc/images/html/pcl_viewer.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/pcl_viewer.png rename to robotics-ai-suite/docs/rvc/images/html/pcl_viewer.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/robotic-arm-graphic.png b/robotics-ai-suite/docs/rvc/images/html/robotic-arm-graphic.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/robotic-arm-graphic.png rename to robotics-ai-suite/docs/rvc/images/html/robotic-arm-graphic.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/rotatedBB.png b/robotics-ai-suite/docs/rvc/images/html/rotatedBB.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/rotatedBB.png rename to robotics-ai-suite/docs/rvc/images/html/rotatedBB.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/sethomeposition.png b/robotics-ai-suite/docs/rvc/images/html/sethomeposition.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/sethomeposition.png rename to robotics-ai-suite/docs/rvc/images/html/sethomeposition.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/setremotecontrol.png b/robotics-ai-suite/docs/rvc/images/html/setremotecontrol.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/setremotecontrol.png rename to robotics-ai-suite/docs/rvc/images/html/setremotecontrol.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/html/tftree.svg b/robotics-ai-suite/docs/rvc/images/html/tftree.svg similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/html/tftree.svg rename to robotics-ai-suite/docs/rvc/images/html/tftree.svg diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/ros/ros2_humble.png b/robotics-ai-suite/docs/rvc/images/ros/ros2_humble.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/ros/ros2_humble.png rename to robotics-ai-suite/docs/rvc/images/ros/ros2_humble.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/static/favicon.png b/robotics-ai-suite/docs/rvc/images/static/favicon.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/static/favicon.png rename to robotics-ai-suite/docs/rvc/images/static/favicon.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/images/static/logo.png b/robotics-ai-suite/docs/rvc/images/static/logo.png similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/images/static/logo.png rename to robotics-ai-suite/docs/rvc/images/static/logo.png diff --git a/robotics-ai-suite/robot-vision-control/docs/source/index.rst b/robotics-ai-suite/docs/rvc/index.rst similarity index 97% rename from robotics-ai-suite/robot-vision-control/docs/source/index.rst rename to robotics-ai-suite/docs/rvc/index.rst index 01f6e16506..da5497617a 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/index.rst +++ b/robotics-ai-suite/docs/rvc/index.rst @@ -4,7 +4,7 @@ Stationary Robot Vision & Control ###################################### -.. image:: images/html/robotic-arm-graphic.png +.. image:: ../images/html/robotic-arm-graphic.png Robotics Pick and Place in Industrial Fields ============================================ @@ -54,7 +54,7 @@ Robot Vision and Control aims at tackling the problematics and offers a flexible Robot Vision and Control is a robotic software framework aimed at tackling Pick and place, Track and place industrial problems. -.. image:: images/html/RobotBackground.png +.. image:: ../images/html/RobotBackground.png Stationary Robot Vision & Control Resources diff --git a/robotics-ai-suite/robot-vision-control/docs/source/releasenotes.rst b/robotics-ai-suite/docs/rvc/releasenotes.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/releasenotes.rst rename to robotics-ai-suite/docs/rvc/releasenotes.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/rvc_dictionary.txt b/robotics-ai-suite/docs/rvc/rvc_dictionary.txt similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/rvc_dictionary.txt rename to robotics-ai-suite/docs/rvc/rvc_dictionary.txt diff --git a/robotics-ai-suite/robot-vision-control/docs/source/substitutions.txt b/robotics-ai-suite/docs/rvc/substitutions.txt similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/substitutions.txt rename to robotics-ai-suite/docs/rvc/substitutions.txt diff --git a/robotics-ai-suite/robot-vision-control/docs/source/troubleshooting.rst b/robotics-ai-suite/docs/rvc/troubleshooting.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/troubleshooting.rst rename to robotics-ai-suite/docs/rvc/troubleshooting.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases.rst b/robotics-ai-suite/docs/rvc/use_cases.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases.rst rename to robotics-ai-suite/docs/rvc/use_cases.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case.rst b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case.rst similarity index 100% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case.rst rename to robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case.rst diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/state_machine_node.rst b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/state_machine_node.rst similarity index 98% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/state_machine_node.rst rename to robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/state_machine_node.rst index 6a7cb08c40..d2dc8f79a5 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/state_machine_node.rst +++ b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/state_machine_node.rst @@ -150,13 +150,13 @@ the two, here is the conversion: -.. image:: images/html/convertWaypoint.png +.. image:: ../../../images/html/convertWaypoint.png :alt: UR External Control 1. Assure that the drop down ``Feature`` is set to ``base`` 2. Assure that the TCP offset takes in account how far the gripper picking position is (in this case our gripper closed fingertips is at 17.5 cm from End effector of UR5e) -.. image:: images/html/TCPOffset.png +.. image:: ../../../images/html/TCPOffset.png :alt: UR External Control diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/system_config.rst b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/system_config.rst similarity index 98% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/system_config.rst rename to robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/system_config.rst index 54dbe99682..158d39f373 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/system_config.rst +++ b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/system_config.rst @@ -119,7 +119,7 @@ Configure the URCaps for the robot and the Robotiq 2F-85 URCap. For details, ref After installing `external_control.urcap`, the screen, shown in the following figure, will be displayed. -.. image:: images/html/URExternalControl.png +.. image:: ../../../images/html/URExternalControl.png :alt: UR External Control .. note:: @@ -142,7 +142,7 @@ Install these URCaps on the UR5e robot teach pendant using a USB drive. Restart the robot. Select **Program Robot** on the Welcome screen. Go to the **Installation** tab. Select **Gripper** listed under **URCaps**. -.. image:: images/html/URRobotiqGripper.png +.. image:: ../../../images/html/URRobotiqGripper.png :alt: UR Robotiq Gripper urcap @@ -199,7 +199,7 @@ Create Program To use the new URCaps, enabling the communication with the Intel® architecture RVC controller, create a new program on the teaching pendant and insert the **External Control** program node in the program tree. -.. image:: images/html//URCreateProgram.png +.. image:: ../../../images/html//URCreateProgram.png :alt: Create Program .. note:: @@ -237,5 +237,5 @@ correctly homed before initiating any automated behavior. | Wrist 3 | 0° | +----------+---------------+ -.. image:: images/html/sethomeposition.png +.. image:: ../../../images/html/sethomeposition.png :alt: setting home position diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/vision_main_node.rst b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/vision_main_node.rst similarity index 95% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/vision_main_node.rst rename to robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/vision_main_node.rst index f46cd31d92..ab01989555 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/vision_main_node.rst +++ b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/vision_main_node.rst @@ -49,18 +49,18 @@ Here the step by step procedure: - Create the stl file to 3D print the object via `FreeCAD `_ or similar - Import the stl file via `Blender `_ -.. image:: images/html/importSTL.png +.. image:: ../../../images/html/importSTL.png :alt: Import STL Blender menu - Edit so the metrics matches the Realsense Camera metrics: Units are in meters AND the center of the object is in the origin of blender and parallel to the axes where applicable. In short, perform scaling, rotating and translating operations so that dimension matches the realsense camera and the rototranslation from blender origin matches the desired outcome. For example, looking at the following image, the imported STL has been scaled down so the side of the cube is 5CM (0.05 meters), and translated down the Z axis of 0.025 centimeters, so the center of the cube is at 0,0,0. No rotation was needed as the cube was already parallel to the absolute reference system. -.. image:: images/html/editObject.png +.. image:: ../../../images/html/editObject.png :alt: Transform object by scaling, rotating and translating with Blender - Export the object in WaveFront format (.obj) as shown in picture -.. image:: images/html/exportToObj.png +.. image:: ../../../images/html/exportToObj.png :alt: Blender menu to export selected object to WaveFront format @@ -69,7 +69,7 @@ Here the step by step procedure: Note: Important consideration: The RVC Pose Detector will align this object PCD file to the input cloud from realsense. This means calculating how much every points of the object pcd are translated and rotated on top of the realsense poincloud from the original file location. To have a consistent meaning, the object baricenter should be in the origin to simulate the center of the optical camera (where all the optical and depth information are translated to). in this way, the algorithm will determine how far and how rotated is the object from the camera optical lense. if the object is not centered in 0,0,0, this calculation would be wrong. See following picture: -.. image:: images/html/CenteredObject.png +.. image:: ../../../images/html/CenteredObject.png :alt: Vertices of a 0,0,0 centered object @@ -91,7 +91,7 @@ Verify that the PCD file has enough points using the pcl_viewer tool which comes As show in following image -.. image:: images/html/pcl_viewer.png +.. image:: ../../../images/html/pcl_viewer.png :alt: PCD visualizer rvc_use_case_binaries package creation diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/visualization.rst b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/visualization.rst similarity index 95% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/visualization.rst rename to robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/visualization.rst index 2abeb97b3f..a697828317 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/visualization.rst +++ b/robotics-ai-suite/docs/rvc/use_cases/dynamic_use_case/visualization.rst @@ -7,7 +7,7 @@ Rviz2 Plugin A rviz2 plugin has been implemented to give full control of the use case in the same HMI: -.. image:: images/html/RvizDynamicUseCase1.png +.. image:: ../../../images/html/RvizDynamicUseCase1.png :alt: RViz2 Control Panel Custom plugin - Enable/Disable motion button diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/static_use_case.rst b/robotics-ai-suite/docs/rvc/use_cases/static_use_case.rst similarity index 95% rename from robotics-ai-suite/robot-vision-control/docs/source/use_cases/static_use_case.rst rename to robotics-ai-suite/docs/rvc/use_cases/static_use_case.rst index 1888179a04..012577f649 100644 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/static_use_case.rst +++ b/robotics-ai-suite/docs/rvc/use_cases/static_use_case.rst @@ -23,7 +23,7 @@ and orientation in space with a 2.5D algorithm and the robot picks it up accordi The only configuration needed on the robot, is to put the teaching pendant in ``remote control`` as show in following picture - .. image:: images/html/setremotecontrol.png + .. image:: ../../images/html/setremotecontrol.png :alt: Setting pendant to Remote control diff --git a/robotics-ai-suite/robot-vision-control/docs/Makefile b/robotics-ai-suite/robot-vision-control/docs/Makefile deleted file mode 100644 index 195cf0ba18..0000000000 --- a/robotics-ai-suite/robot-vision-control/docs/Makefile +++ /dev/null @@ -1,44 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = "-W" -SPHINXBUILD = sphinx-build -SPHINXBUILD_V = sphinx-multiversion -SOURCEDIR = source -BUILDDIR = build -BUILDDIR_I = build/html_internal -BUILDDIR_V = build/html_version -COMMIT = $(shell git rev-parse HEAD) - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -clean: - rm -rf "$(BUILDDIR)" - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -t release - -.PHONY: html -html: - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -A is_latest=1 -t release - cp -r $(SOURCEDIR)/images/html ./${BUILDDIR}/html/_images/html - -.PHONY: ditaxml -ditaxml: - rm -rf ./${BUILDDIR}/doctrees - rm -rf ./${BUILDDIR}/ditaxml - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -A is_latest=1 -t ditaxml - cp -r $(SOURCEDIR)/images/html ./${BUILDDIR}/ditaxml/_images/html - -.PHONY: doxygen -doxygen: - rm -rf source/doxygen/rvc_control/xml source/doxygen/rvc_vision/xml - cp -rp ../src/rvc_control/xml source/doxygen/rvc_control/ - cp -rp ../src/rvc_vision/xml source/doxygen/rvc_vision/ diff --git a/robotics-ai-suite/robot-vision-control/docs/README.md b/robotics-ai-suite/robot-vision-control/docs/README.md index a0077da92e..a5081a2968 100644 --- a/robotics-ai-suite/robot-vision-control/docs/README.md +++ b/robotics-ai-suite/robot-vision-control/docs/README.md @@ -1,78 +1,3 @@ # Robotic Vision & Control [RVC] Documentation -This directory contains the **Robotic Vision & Control [RVC]** system documentation, which is built from source using [Sphinx](https://www.sphinx-doc.org/). The following instructions will guide you through setting up the environment, installing dependencies, and building the HTML documentation. - ---- - -## 1. Install System Dependencies - -Before setting up the Python environment, ensure that essential system packages are installed. These packages include: - -* `python3-pip` – for installing Python packages -* `graphviz` – for rendering diagrams in Sphinx -* `libenchant-2-dev` – required by spelling check extensions - - -```bash -sudo apt update -sudo apt install python3-pip -sudo apt install graphviz libenchant-2-dev -``` - ---- - -## 2. Set Up a Python Virtual Environment - -Though not necessary, it is recommended to use a virtual environment to keep dependencies isolated. - -```bash -# Navigate to the documentation folder -export DOCS_DIR= -cd $DOCS_DIR/edge-ai-suites/robotics-ai-suite/robot-vision-control/docs - -# Create a new virtual environment -python3 -m venv venv_robotics-ai-suite-docs - -# Activate the virtual environment -source venv_robotics-ai-suite-docs/bin/activate -``` - ---- - -## 3. Upgrade pip, setuptools, and wheel - -Inside the virtual environment, upgrade core Python packaging tools. This ensures compatibility with modern packages. - -```bash -pip install --upgrade pip setuptools wheel -``` - ---- - -## 4. Install Python Dependencies - -With the virtual environment active, install all Python dependencies required to build the documentation: - -```bash -pip install -r requirements.txt -``` - -Now reactivate the virtual environment: - -```bash -source venv_robotics-ai-suite-docs/bin/activate -``` - ---- - -## 5. Build HTML Documentation - -Once dependencies are installed and the virtual environment is active, generate the HTML version of the documentation: - -```bash -make html -``` - -The output will be available in the `build/html` folder inside your `docs` directory. You can open the `index.html` file in a browser to view the documentation. - ---- \ No newline at end of file +The documentation files are at https://github.com/open-edge-platform/edge-ai-suites/tree/main/robotics-ai-suite/docs/rvc. \ No newline at end of file diff --git a/robotics-ai-suite/robot-vision-control/docs/requirements.txt b/robotics-ai-suite/robot-vision-control/docs/requirements.txt deleted file mode 100644 index 33663eeeda..0000000000 --- a/robotics-ai-suite/robot-vision-control/docs/requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -rst2pdf==0.101 -Sphinx==7.2.6 -sphinx-rtd-theme>=2.0.0 -sphinx-tabs==3.4.5 -sphinx-copybutton==0.5.2 -sphinxcontrib-contentui==0.2.5 -sphinxcontrib-spelling==8.0.0 -breathe==4.35.0 -docutils==0.20.1 -sphinx-multiversion==0.2.4 diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/images b/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/images deleted file mode 120000 index 5fa6987088..0000000000 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/dynamic_use_case/images +++ /dev/null @@ -1 +0,0 @@ -../../images \ No newline at end of file diff --git a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/images b/robotics-ai-suite/robot-vision-control/docs/source/use_cases/images deleted file mode 120000 index 5e67573196..0000000000 --- a/robotics-ai-suite/robot-vision-control/docs/source/use_cases/images +++ /dev/null @@ -1 +0,0 @@ -../images \ No newline at end of file