diff --git a/ros1/getting_started.md b/ros1/getting_started.md index 183394e..1da3d63 100644 --- a/ros1/getting_started.md +++ b/ros1/getting_started.md @@ -1,60 +1,26 @@ # Getting Started -## Ubuntu +## Prerequisites +1. A Stretch robot (see below for simulation instructions if you don’t have a robot) +2. Follow the [Getting Started]() guide (hello_robot_xbox_teleop must not be running in the background) +3. Interacting with Linux through the [command line](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) +4. Basic understanding of [ROS](http://wiki.ros.org/ROS/Tutorials) +5. Setup [untethered operation](https://docs.hello-robot.com/0.2/stretch-tutorials/getting_started/untethered_operation/) (optional) -Hello Robot utilizes Ubuntu, an open-source Linux operating system, for the Stretch platform. If you are unfamiliar with the operating system, we encourage you to review a [tutorial](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) provided by Ubuntu. Additionally, the Linux command line, BASH, is used to execute commands and is needed to run ROS on the Stretch robot. Here is a [tutorial](https://ryanstutorials.net/linuxtutorial/) on getting started with BASH. - -## Installing Noetic on Stretch -Instructions on installing Noetic can be found in our open-source [installation guide](https://github.com/hello-robot/stretch_ros/blob/dev/noetic/install_noetic.md). Then create a catkin workspace for your ROS packages. Here is an [installation guide for creating a workspace](http://wiki.ros.org/catkin/Tutorials/create_a_workspace). Once your system is set up, clone the [stretch_tutorials](https://github.com/hello-robot/stretch_tutorials) to your workspace and build the package in your workspace. This can be done by copying the commands below and pasting them into your terminal. - -```bash -cd ~/catkin_ws/src -git clone https://github.com/hello-robot/stretch_tutorials.git -cd stretch_tutorials -git checkout noetic -cd ~/catkin_ws -catkin_make -``` ### Connecting a Monitor If you cannot access the robot through ssh due to your network settings, you will need to connect an HDMI monitor, USB keyboard, and mouse to the USB ports in the robot's trunk. -## ROS Setup on Local Computer - -Hello Robot is currently running Stretch on Ubuntu 20.04 and ROS Noetic. To begin the setup, start with [installing Ubuntu desktop](https://ubuntu.com/tutorials/install-ubuntu-desktop#1-overview) on your local machine. Then follow the [installation guide for ROS Noetic](http://wiki.ros.org/noetic/Installation/Ubuntu) on your system. - -Currently, the Realsense2_description package isn't installed by rosdep and requires a user to install the package manually. Run the following command in your terminal - -```bash -sudo apt-get install ros-noetic-realsense2-camera -``` - -After your system is setup, clone the [stretch_ros](https://github.com/hello-robot/stretch_ros.git), [stretch_tutorials](https://github.com/hello-robot/stretch_tutorials.git), and [realsense_gazebo_plugin packages]( https://github.com/pal-robotics/realsense_gazebo_plugin) to your **src** folder in your preferred workspace. -```bash -cd ~/catkin_ws/src -git clone https://github.com/hello-robot/stretch_ros -git clone https://github.com/pal-robotics/realsense_gazebo_plugin -git clone https://github.com/hello-robot/stretch_tutorials.git -``` - - -Change the directory to that of your catkin workspace and install system dependencies of the ROS packages. Then build your workspace. -```bash -cd ~/catkin_ws -rosdep install --from-paths src --ignore-src -r -y -catkin_make -``` - - -Once `caktin_make` has finished compiling,source your workspace and **.bashrc** file -```bash -echo "source /home/USER_NAME/catkin_ws/devel/setup.bash" -source ~/.bashrc -``` +## Setting Up Stretch in Simulation +Users who don’t have a Stretch, but want to try the tutorials can set up their computer with Stretch Gazebo. -## RoboMaker +Although lower specifications might be sufficient, for the best experience we recommend the following for running the simulation: +**Processor**: Intel i7 or comparable +**Memory**: 16 GB +**Storage**: 50 GB +**OS**: Ubuntu 20.04 +**Graphics Card**: NVIDIA GTX2060 (optional) -

- -

+### Setup +Hello Robot is currently running Stretch on Ubuntu 20.04 and ROS Noetic. To begin the setup, follow the [Run the new robot installation script](https://github.com/hello-robot/stretch_install/blob/master/docs/robot_install.md#run-the-new-robot-installation-script) on your system. -If you cannot dual boot and install ubuntu on your local machine, an alternative is to use [AWS RoboMaker](https://aws.amazon.com/robomaker/). AWS RoboMaker extends the ROS framework with cloud services. The service provides a robotics simulation service, allowing for testing the Stretch platform. If you are a first-time user of AWS RoboMaker, follow the [guide here](https://github.com/aws-robotics/aws-robomaker-robotics-curriculum/blob/main/getting-started-with-aws-robomaker/_modules/mod-2a-aws.md) to get up and running with the service. \ No newline at end of file +Finally, follow the [Creating a new ROS workspace](https://github.com/hello-robot/stretch_install/blob/master/docs/ros_workspace.md) guide to create a fresh catkin workspace complete with all the dependencies. \ No newline at end of file diff --git a/ros2/getting_started.md b/ros2/getting_started.md index 7434be1..31ebd70 100644 --- a/ros2/getting_started.md +++ b/ros2/getting_started.md @@ -2,24 +2,28 @@ **NOTE**: ROS 2 tutorials are still under active development. -## Installing Ubuntu 20.04 with ROS 2 Galactic on Stretch -Hello Robot utilizes Ubuntu, an open source Linux operating system, for the Stretch RE1 platform. If you are unfamiliar with the operating system, we encourage you to review a [tutorial](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) provided by Ubuntu. Additionally, the Linux command line, BASH, is used to execute commands and is needed to run ROS on the Stretch robot. Here is a [tutorial](https://ryanstutorials.net/linuxtutorial/) on getting started with BASH. - -Instructions on installing Ubuntu 20.04 with ROS Noetic and ROS 2 Galactic can be found in our open source [installation guide](https://github.com/hello-robot/stretch_ros/blob/dev/noetic/install_noetic.md). Following these steps should create a separate Ubuntu 20.04 partition with an ament worskspace created in the home directory. - -## ROS 2 Tutorials Setup on Local Computer -Once your system is setup, clone the [stretch_ros_tutorials](https://github.com/hello-sanchez/stretch_ros_tutorials.git) repo to the src directory of the ament workspace, then build the packages. - -``` -cd ~/ament_ws/src -git clone https://github.com/hello-robot/stretch_tutorials.git -git checkout ROS2 -cd ~/ament_ws -colcon build -``` - -Then source your workspace with the following command -``` -source ~/ament_ws/install/setup.bash" -``` +## Prerequisites +1. A Stretch robot (see below for simulation instructions if you don’t have a robot) +2. Follow the [Getting Started]() guide (hello_robot_xbox_teleop must not be running in the background) +3. Interacting with Linux through the [command line](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) +4. Basic understanding of [ROS](http://wiki.ros.org/ROS/Tutorials) +5. Setup [untethered operation](https://docs.hello-robot.com/0.2/stretch-tutorials/getting_started/untethered_operation/) (optional) + +### Connecting a Monitor +If you cannot access the robot through ssh due to your network settings, you will need to connect an HDMI monitor, USB keyboard, and mouse to the USB ports in the robot's trunk. + +## Setting Up Stretch in Simulation +Users who don’t have a Stretch, but want to try the tutorials can set up their computer with Stretch Gazebo. + +Although lower specifications might be sufficient, for the best experience we recommend the following for running the simulation: +**Processor**: Intel i7 or comparable +**Memory**: 16 GB +**Storage**: 50 GB +**OS**: Ubuntu 20.04 +**Graphics Card**: NVIDIA GTX2060 (optional) + +### Setup +Hello Robot is currently running Stretch on Ubuntu 20.04 and ROS 2 Galactic. To begin the setup, follow the [Run the new robot installation script](https://github.com/hello-robot/stretch_install/blob/master/docs/robot_install.md#run-the-new-robot-installation-script) on your system. + +Finally, follow the [Creating a new ROS workspace](https://github.com/hello-robot/stretch_install/blob/master/docs/ros_workspace.md) guide to create a fresh catkin workspace complete with all the dependencies.