Skip to content

Commit 85a474d

Browse files
authored
[README.md] Updating ROS2 install documentation.
1 parent 92d4a2b commit 85a474d

File tree

1 file changed

+10
-58
lines changed

1 file changed

+10
-58
lines changed

README.md

Lines changed: 10 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -9,50 +9,26 @@
99
| `sas_msgs` | LGPL | A wrapper for `ROS` messages that were made redundant in `ROS2`. |
1010
| `sas_conversions` | LGPL | Convert `ROS2` messages into `float`, `int`, or `dqrobotics` elements. |
1111
| `sas_robot_driver` | LGPL | `ROS2` nodes and libraries for creating servers and clients for robot configuration-space monitoring and control. |
12-
| `sas_robot_driver_denso` | LGPL | A `sas_robot_driver` implementation for DensoWave's bCap controlled robots |
1312
| `sas_robot_kinematics` | LGPL | `ROS2` nodes and libraries for creating servers and clients for kinematic-level robot task-space monitoring and control. |
14-
| `sas_operator_side_receiver` | Research Only | Receive messages from a [master device](https://github.com/SmartArmStack/smart_arm_master_windows) and expose them in `ROS2`. |
15-
| `sas_patient_side_manager` | Research Only | Connects `n` `OperatorSideMasterReceiverManipulatorManager` with `m` `sas_robot_kinematics`, for teleoperation. |
16-
| `sas_robot_kinematics_constrained_multiarm`| Research Only | Kinematically control `m` robots in a centralized manner, with configurable VFIs |
13+
| `sas_robot_driver_denso` | LGPL | A `sas_robot_driver` implementation for DensoWave's bCap controlled robots |
14+
| `sas_robot_driver_kuka` | LGPL | A `sas_robot_driver` implementation for Kuka (Sunrise cabinet, FRI) |
15+
| `sas_robot_driver_ur` | LGPL | A `sas_robot_driver` implementation for UR |
16+
1717

1818
# Prerequisites
19-
1. [ROS 2 Humble](https://docs.ros.org/en/humble/Installation/Alternatives/Ubuntu-Development-Setup.html)
19+
1. [ROS 2 Jazzy](https://docs.ros.org/en/jazzy/Installation/Alternatives/Ubuntu-Development-Setup.html)
2020
2. DQ Robotics CPP ([Development branch](https://dqroboticsgithubio.readthedocs.io/en/latest/installation/cpp.html#development-ppa))
2121
```commandline
2222
sudo add-apt-repository ppa:dqrobotics-dev/development
2323
sudo apt-get update
24-
sudo apt-get install libdqrobotics*
24+
sudo apt-get install libdqrobotics libdqrobotics-interface-json11 libdqrobotics-interface-vrep-4.7.0-2
2525
```
2626
3. DQ Robotics Python ([pre-release](https://dqroboticsgithubio.readthedocs.io/en/latest/installation/python.html#installation-development))
2727
```commandline
2828
python3 -m pip install dqrobotics --pre
2929
```
3030

31-
# Set up the installer
32-
33-
Do the following **ONLY ONCE**
34-
35-
```sh
36-
sudo apt install curl jq -y
37-
echo "alias sas-ros2-update='wget https://raw.githubusercontent.com/SmartArmStack/smart_arm_stack_ROS2/main/install.sh && sh install.sh'" >> ~/.bashrc
38-
source ~/.bashrc
39-
```
40-
41-
# Install and update
42-
43-
```sh
44-
sas-ros2-update
45-
```
46-
47-
# Draft doxygen docs
48-
49-
https://smartarmstack.github.io/docs_ros2
50-
51-
# Devel
52-
53-
For regular users, the recommendation is to install the `.deb` packages, not build from source.
54-
55-
## Do once
31+
# Do once
5632

5733
On the ROS2 workspace, e.g. `~/ros2_ws/src`
5834

@@ -62,41 +38,17 @@ cd ~/ros2_ws/src
6238
git clone git@github.com:SmartArmStack/smart_arm_stack_ROS2.git sas --recursive
6339
```
6440

65-
## Every build
41+
# Every build
6642

6743
```commandline
6844
cd ~/ros2_ws/src
6945
colcon build --symlink-install
7046
source install/setup.bash
7147
```
7248

73-
## Aliases
74-
75-
Optionally, also install
76-
```commandline
77-
sudo apt install python3-colcon-clean
78-
```
49+
# Opening a package on QTCreator
7950

80-
Then add the following aliases to `.bashrc`
81-
82-
```commandline
83-
alias cdros2="cd ~/ros2_ws/src"
84-
alias cleanros2="cdros2 && colcon clean workspace"
85-
alias buildros2="cdros2 && colcon build --symlink-install && source install/setup.bash"
86-
```
87-
88-
So that the following become `bash` commands become available
89-
90-
- `cdros2`: go to the source of your ros2 workspace.
91-
- `cleanros2`: clean the workspace, e.g. remove the `install`, `build`, and `log` folders.
92-
- `buildros2`: do a standard build of the workspace and source the `setup.bash`.
93-
94-
## Opening a package on QTCreator
95-
96-
1. First, open a terminal and run
97-
```commandline
98-
buildros2
99-
```
51+
1. First, be sure that the environment has been compiled and sourced as shown in the last step.
10052

10153
2. In that same terminal, open QTCreator, e.g. by running
10254
```commandline

0 commit comments

Comments
 (0)