Skip to content

Commit c6f4f84

Browse files
committed
Update robot_description README
1 parent 169b0e8 commit c6f4f84

File tree

1 file changed

+79
-1
lines changed
  • coffee_ws/src/coffee_robot_description

1 file changed

+79
-1
lines changed

coffee_ws/src/coffee_robot_description/README.md

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,66 @@ The `coffee_robot_description` package contains:
3535
- **Ear Motors**: Left and right ear actuation (45° range each)
3636
- **Additional Sensors**: IMU, additional cameras
3737

38+
## Quick Start
39+
40+
### Automated Setup (Recommended)
41+
42+
The Coffee Buddy project includes automated setup scripts that handle all dependencies and configuration for both Ubuntu and macOS:
43+
44+
```bash
45+
# Initial setup (run once)
46+
./scripts/setup_workspace.sh
47+
48+
# Daily activation (run in each new terminal)
49+
source scripts/activate_workspace.sh
50+
```
51+
52+
**Platform Support:**
53+
- **Ubuntu/Debian**: Uses native ROS2 with apt + Python virtual environment
54+
- **macOS**: Uses RoboStack with mamba/conda environment
55+
56+
**What the setup script installs:**
57+
- ROS2 Jazzy with all required packages (`xacro`, `joint-state-publisher-gui`, etc.)
58+
- Robot state publisher and visualization tools
59+
- Development tools (colcon, cmake, etc.)
60+
- Python dependencies
61+
- Builds all workspace packages automatically
62+
63+
### Manual Control GUI
64+
65+
Once setup is complete, run the robot description with manual joint control:
66+
67+
```bash
68+
# Activate environment (if not already active)
69+
source scripts/activate_workspace.sh
70+
71+
# Launch with manual control GUI
72+
cd coffee_ws
73+
ros2 launch coffee_robot_description rviz_display.launch.py use_manual_control:=true
74+
```
75+
76+
This opens RViz with the 3D robot model and a GUI with sliders to manually control joint angles.
77+
3878
## Installation
3979

40-
### Prerequisites
80+
### Automated Setup (Recommended)
81+
82+
**Use the project setup scripts for the easiest installation:**
83+
84+
```bash
85+
# From the project root directory
86+
./scripts/setup_workspace.sh
87+
```
88+
89+
This handles all dependencies, environment setup, and builds all packages automatically for both Ubuntu and macOS.
90+
91+
### Manual Installation (Advanced/Development)
92+
93+
If you prefer manual installation or need to install individual components:
94+
95+
#### Prerequisites
96+
97+
**For Ubuntu/Debian (manual installation):**
4198

4299
```bash
43100
# Core ROS2 dependencies (required)
@@ -51,6 +108,11 @@ sudo apt install ros-jazzy-joint-state-publisher ros-jazzy-joint-state-publisher
51108
sudo apt install ros-jazzy-gazebo-ros-pkgs ros-jazzy-controller-manager ros-jazzy-joint-trajectory-controller
52109
```
53110

111+
**For macOS:**
112+
Use RoboStack with mamba (see automated setup script or RoboStack documentation).
113+
114+
**Note**: The automated setup script (`./scripts/setup_workspace.sh`) handles all these dependencies automatically for both platforms.
115+
54116
**Note**: If you encounter GPG key errors during installation, update your ROS2 repository configuration:
55117
```bash
56118
# Modern repository setup (automatic key management)
@@ -62,6 +124,11 @@ sudo apt update
62124

63125
### Build the Package
64126

127+
**Using Automated Setup (Recommended):**
128+
The setup script builds all packages automatically. If you used `./scripts/setup_workspace.sh`, you can skip this section.
129+
130+
**Manual Build (for development/changes):**
131+
65132
```bash
66133
cd coffee_ws
67134

@@ -72,8 +139,19 @@ colcon build --packages-select coffee_robot_description
72139
source install/setup.bash
73140
```
74141

142+
**Note**: After making changes to URDF files or launch files, you only need to rebuild this specific package using the commands above.
143+
75144
## Usage
76145

146+
**Environment Setup**: Before running any commands, make sure your environment is activated:
147+
```bash
148+
# If using automated setup
149+
source scripts/activate_workspace.sh
150+
151+
# Or manually (if you built manually)
152+
cd coffee_ws && source install/setup.bash
153+
```
154+
77155
The package supports **dual-mode operation** for different use cases:
78156

79157
### Mode 1: Hardware Integration (Default)

0 commit comments

Comments
 (0)