Skip to content

Commit

Permalink
[PN-126] Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gbrooks-bdai committed Feb 5, 2024
1 parent f7fb7e3 commit ce27954
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion spot_driver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# spot_driver

This package provides ROS 2 nodes to interact with Spot through its C++ SDK.
This package provides ROS 2 nodes to interact with Spot through its SDK.

## Why Python?
Being known for it's ease of use and flexibility, the Spot Python SDK is used for many operations.
There are several entry points, though it is recommended to use the provided launch files.

- `spot_ros2` is the node used to connect to the spot and creates ROS 2 action servers and services.
- `command_spot` provides a command line interface with ROS 2 clients to send simple commands.
- `spot_publish_cameras` publishes camera images from spot cameras to ROS topics.
> :warning: **Warning:** For performance reasons, `spot_publish_cameras` is being rewritten in C++.
## Why C++?

Expand Down

0 comments on commit ce27954

Please sign in to comment.