Skip to content

Commit

Permalink
Update getting started docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewjong committed Dec 19, 2024
1 parent 5526251 commit 63587da
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
4 changes: 4 additions & 0 deletions docs/development/project_configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Project Configuration

The project as a whole can be configured using the `.env` file under the project root.
The variables in the `.env` file gets populated into the root `docker-compose.yml`.
14 changes: 2 additions & 12 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,21 +88,11 @@ This will automatically launch and play the Isaac scene specified under `AirStac

## Move Robot

Find the RQT GUI window. Hit `Takeoff`, then hit `Publish` in the trajectory window like in this video:
Find the RQT GUI window. Hit `Arm and Takeoff`, then hit `Global Plan` in the trajectory window like in this video:

<iframe src="https://drive.google.com/file/d/1XYgSUTU5tf6e6sOuStYJXIs2SK3XL7g6/preview?usp=sharing&t=0" width="840" height="480" allow="autoplay" allowfullscreen="allowfullscreen"></iframe>

Note you can also use the `ros2 topic pub` command to move the robot. For example, to fly to a position:

```bash
# start another terminal in docker container
docker exec -it airstack-robot-1 bash
# in docker
# FLY TO POSITION. Put whatever position you want
ros2 topic pub /robot_1/interface/mavros/setpoint_position/local geometry_msgs/PoseStamped \
"{ header: { stamp: { sec: 0, nanosec: 0 }, frame_id: 'base_link' }, \
pose: { position: { x: 10.0, y: 0.0, z: 20.0 }, orientation: { x: 0.0, y: 0.0, z: 0.0, w: 1.0 } } }" -1
```
You can also switch to `Fixed Trajectory` mode and hit `Publish` on the bottom right to fly a predefined trajectory.

## Shutdown

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ nav:
- docs/development/index.md
- docs/development/docker_usage.md
- docs/development/vscode/index.md
- docs/development/project_configuration.md
- Testing:
- docs/development/testing/index.md
- docs/development/testing/testing_frameworks.md
Expand Down

0 comments on commit 63587da

Please sign in to comment.