ROSA: the Robot Operating System Agent
Project description
ROSA - The ROS Agent 🤖
The ROS Agent (ROSA) is designed to interact with ROS-based
robotics systems using natural language queries. 🗣️🤖
[!IMPORTANT] 📚 New to ROSA? Check out our Wiki for documentation, guides and FAQs!
ROSA is your AI-powered assistant for ROS1 and ROS2 systems. Built on the Langchain framework, ROSA helps you interact with robots using natural language, making robotics development more accessible and efficient.
🚀 Quick Start
Requirements
- Python 3.9+
- ROS Noetic or higher
Installation
pip3 install jpl-rosa
Usage Examples
from rosa import ROSA
llm = get_your_llm_here()
rosa = ROSA(ros_version=1, llm=llm)
rosa.invoke("Show me a list of topics that have publishers but no subscribers")
For detailed information on configuring the LLM, please refer to our Model Configuration Wiki page.
Adapting ROSA for Your Robot 🔧
ROSA is designed to be easily adaptable to different robots and environments. You can create custom agents by either inheriting from the ROSA class or creating a new instance with custom parameters.
For detailed information on creating custom agents, adding tools, and customizing prompts, please refer to our Custom Agents Wiki page.
TurtleSim Demo 🐢
We have included a demo that uses ROSA to control the TurtleSim robot in simulation. To run the demo, you will need to have Docker installed on your machine. 🐳
The following video shows ROSA reasoning about how to draw a 5-point star, then executing the necessary commands to do so.
https://github.com/user-attachments/assets/77b97014-6d2e-4123-8d0b-ea0916d93a4e
For detailed instructions on setting up and running the TurtleSim demo, please refer to our TurtleSim Demo Guide in the Wiki.
📘 Learn More
Changelog
See our CHANGELOG.md for a history of our changes.
Contributing
Interested in contributing to our project? Please see our: CONTRIBUTING.md
For guidance on how to interact with our team, please see our code of conduct located at: CODE_OF_CONDUCT.md
For guidance on our governance approach, including decision-making process and our various roles, please see our governance model at: GOVERNANCE.md
License
See our: LICENSE
Support
Key points of contact are:
Copyright (c) 2024. Jet Propulsion Laboratory. All rights reserved.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
