Restructuring sr_example (#834)

* restructuring sr_example, adapting readme * removing basic and advanced * removing basic and advanced * small readme changes --------- Co-authored-by: Jesús Ferrándiz <[email protected]>
shadow-robot · Jun 29, 2023 · 48ef110 · 48ef110
1 parent e74a162
commit 48ef110
Show file tree

Hide file tree

Showing 28 changed files with 5 additions and 28 deletions.
diff --git a/sr_example/CHANGELOG.rst b/sr_example/CHANGELOG.rst
diff --git a/sr_example/README.md b/sr_example/README.md
@@ -1,17 +1,8 @@
-# Examples
+# Shadow Robot Examples (sr_example)
 
-We are providing a [high level wrapper](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_robot_commander) around our robots to make the interfacing easier for non-ROS people. The [sr_example](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example) package contains examples on how to use it.
+There are several ways to interface with the Shadow Robots. This package provides examples for interfacing through the following methods:
 
-Use cases are given for:
+- Utilising a high-level wrapper called the [Robot Commander](https://github.com/shadow-robot/sr_interface/tree/noetic-devel/sr_robot_commander), which simplifies the interfacing process for those unfamiliar with ROS. Python examples demonstrating use cases for both hand and hand/arm interfaces can be found in the [scripts/robot_commander_examples](scripts/sr_example/robot_commander_examples) folder.
+- Direct ROS interfacing in Python is also available, with examples provided in the [scripts/ros_examples](scripts/sr_example/ros_examples) folder. For those preferring C++, examples can be found in the [src](src) folder.
 
--  [Hand](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example/scripts/sr_example/hand_examples)
--  [Arm](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example/scripts/sr_example/arm_examples)
--  [Hand and arm](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example/scripts/sr_example/hand_and_arm_examples)
-
-To run these examples, the robot should be launched first (instructions for this can be found [here](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_robot_launch)) 
-
-In order to access the full functionality of the hand, you can interface with it directly through the ROS interface. You can find python examples in the
- [advanced](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example/scripts/sr_example/advanced) folder
- and c++ examples in the [src](https://github.com/shadow-robot/sr_interface/tree/melodic-devel/sr_example/src) folder.
-
-Description of each example can be found in the comment at the top of each script.
+Descriptions of each example can be found within the documentation provided within each script.
diff --git a/...e/hand_examples/sr_export_named_states.py → ...mander_examples/sr_export_named_states.py b/...e/hand_examples/sr_export_named_states.py → ...mander_examples/sr_export_named_states.py
diff --git a/.../hand_examples/sr_hand_tactile_example.py → ...ander_examples/sr_hand_tactile_example.py b/.../hand_examples/sr_hand_tactile_example.py → ...ander_examples/sr_hand_tactile_example.py
diff --git a/...le/hand_examples/sr_handfinder_example.py → ...mmander_examples/sr_handfinder_example.py b/...le/hand_examples/sr_handfinder_example.py → ...mmander_examples/sr_handfinder_example.py
diff --git a/..._and_arm_examples/sr_left_arm_examples.py → ...ommander_examples/sr_left_arm_examples.py b/..._and_arm_examples/sr_left_arm_examples.py → ...ommander_examples/sr_left_arm_examples.py
diff --git a/...rm_examples/sr_left_pick_place_example.py → ...er_examples/sr_left_pick_place_example.py b/...rm_examples/sr_left_pick_place_example.py → ...er_examples/sr_left_pick_place_example.py
diff --git a/...ample/hand_examples/sr_move_hand_joint.py → ..._commander_examples/sr_move_hand_joint.py b/...ample/hand_examples/sr_move_hand_joint.py → ..._commander_examples/sr_move_hand_joint.py
diff --git a/..._and_arm_examples/sr_print_ef_position.py → ...ommander_examples/sr_print_ef_position.py b/..._and_arm_examples/sr_print_ef_position.py → ...ommander_examples/sr_print_ef_position.py
diff --git a/...examples/sr_print_hand_joints_position.py → ...examples/sr_print_hand_joints_position.py b/...examples/sr_print_hand_joints_position.py → ...examples/sr_print_hand_joints_position.py
diff --git a/..._arm_examples/sr_right_hand_arm_ef_pos.py → ...nder_examples/sr_right_hand_arm_ef_pos.py b/..._arm_examples/sr_right_hand_arm_ef_pos.py → ...nder_examples/sr_right_hand_arm_ef_pos.py
diff --git a/...m_examples/sr_right_hand_arm_joint_pos.py → ...r_examples/sr_right_hand_arm_joint_pos.py b/...m_examples/sr_right_hand_arm_joint_pos.py → ...r_examples/sr_right_hand_arm_joint_pos.py
diff --git a/...m_examples/sr_right_hand_arm_waypoints.py → ...r_examples/sr_right_hand_arm_waypoints.py b/...m_examples/sr_right_hand_arm_waypoints.py → ...r_examples/sr_right_hand_arm_waypoints.py
diff --git a/.../sr_right_hand_follow_named_trajectory.py → .../sr_right_hand_follow_named_trajectory.py b/.../sr_right_hand_follow_named_trajectory.py → .../sr_right_hand_follow_named_trajectory.py
diff --git a/...nd_examples/sr_right_hand_grasp_object.py → ...er_examples/sr_right_hand_grasp_object.py b/...nd_examples/sr_right_hand_grasp_object.py → ...er_examples/sr_right_hand_grasp_object.py
diff --git a/...es/sr_right_hand_partial_traj_advanced.py → ...es/sr_right_hand_partial_traj_advanced.py b/...es/sr_right_hand_partial_traj_advanced.py → ...es/sr_right_hand_partial_traj_advanced.py
diff --git a/...mples/sr_right_hand_partial_traj_grasp.py → ...mples/sr_right_hand_partial_traj_grasp.py b/...mples/sr_right_hand_partial_traj_grasp.py → ...mples/sr_right_hand_partial_traj_grasp.py
diff --git a/...ples/sr_right_hand_predefined_gestures.py → ...ples/sr_right_hand_predefined_gestures.py b/...ples/sr_right_hand_predefined_gestures.py → ...ples/sr_right_hand_predefined_gestures.py
diff --git a/...arm_examples/sr_right_print_joints_pos.py → ...der_examples/sr_right_print_joints_pos.py b/...arm_examples/sr_right_print_joints_pos.py → ...der_examples/sr_right_print_joints_pos.py
diff --git a/...and_examples/sr_sinusoid_joint_example.py → ...der_examples/sr_sinusoid_joint_example.py b/...and_examples/sr_sinusoid_joint_example.py → ...der_examples/sr_sinusoid_joint_example.py
diff --git a/...sr_example/hand_examples/sr_store_hand.py → ...robot_commander_examples/sr_store_hand.py b/...sr_example/hand_examples/sr_store_hand.py → ...robot_commander_examples/sr_store_hand.py
diff --git a/...e/hand_examples/sr_use_exported_states.py → ...mander_examples/sr_use_exported_states.py b/...e/hand_examples/sr_use_exported_states.py → ...mander_examples/sr_use_exported_states.py
diff --git a/...ples/sr_hand_optoforce_tactile_example.py → ...ples/sr_hand_optoforce_tactile_example.py b/...ples/sr_hand_optoforce_tactile_example.py → ...ples/sr_hand_optoforce_tactile_example.py
diff --git a/...mple/hand_examples/sr_hand_position_ik.py → ...ample/ros_examples/sr_hand_position_ik.py b/...mple/hand_examples/sr_hand_position_ik.py → ...ample/ros_examples/sr_hand_position_ik.py
diff --git a/...r_example/advanced/sr_latching_example.py → ...ample/ros_examples/sr_latching_example.py b/...r_example/advanced/sr_latching_example.py → ...ample/ros_examples/sr_latching_example.py
diff --git a/...xample/advanced/sr_link_joints_example.py → ...le/ros_examples/sr_link_joints_example.py b/...xample/advanced/sr_link_joints_example.py → ...le/ros_examples/sr_link_joints_example.py
diff --git a/..._example/advanced/sr_publisher_example.py → ...mple/ros_examples/sr_publisher_example.py b/..._example/advanced/sr_publisher_example.py → ...mple/ros_examples/sr_publisher_example.py
diff --git a/...example/advanced/sr_subscriber_example.py → ...ple/ros_examples/sr_subscriber_example.py b/...example/advanced/sr_subscriber_example.py → ...ple/ros_examples/sr_subscriber_example.py