Skip to main content

ROSA: the Robot Operating System Agent

Project description


image
The ROS Agent (ROSA) is designed to interact with ROS-based
robotics systems using natural language queries. 🗣️🤖

arXiv ROS 1 ROS 2 License SLIM

Main Branch Dev Branch Publish Status Version Downloads

[!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.

ROSA Demo: NeBula-Spot in JPL's Mars Yard (click for YouTube)

Spot YouTube Thumbnail

🚀 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()
agent = ROSA(ros_version=1, llm=llm)
agent.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.

IsaacSim Extension (Coming Soon)

ROSA is coming to Nvidia IsaacSim! While you can already use ROSA with robots running in IsaacSim (using the ROS/ROS2 bridge), we are adding direct integration in the form of an IsaacSim extension. This will allow you not only to control your robots in IsaacSim, but control IsaacSim itself. Check out the video below to learn mroe.

ROSA Demo: Nvidia IsaacSim Extension (click for YouTube)

Carter YouTube Thumbnail Play

📘 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:


ROSA: Robot Operating System Agent 🤖
Copyright (c) 2024. Jet Propulsion Laboratory. All rights reserved.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jpl_rosa-1.0.9.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jpl_rosa-1.0.9-py3-none-any.whl (54.7 kB view details)

Uploaded Python 3

File details

Details for the file jpl_rosa-1.0.9.tar.gz.

File metadata

  • Download URL: jpl_rosa-1.0.9.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for jpl_rosa-1.0.9.tar.gz
Algorithm Hash digest
SHA256 6191ebc912ce63e6a52bb0c8e1c82e904907584a20d05d737e326e6858851022
MD5 4a902c535b855a5415387029587d8341
BLAKE2b-256 cced146e5518cbf7e9ad09bc1420d24f555cd907082663254591d256518b1d6f

See more details on using hashes here.

File details

Details for the file jpl_rosa-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: jpl_rosa-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 54.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for jpl_rosa-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d3cb10d3377e7cf257b7d11d024cb63944913d762e4bb611401b312836d5b33f
MD5 dd31cc68f5799bc543da48926c59f9c1
BLAKE2b-256 5c98eb0b2809a85a72d856dc680d2932e98fa567d1dd2d618d21b7b159d211e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page