Skip to content

Latest commit

 

History

History
212 lines (149 loc) · 8.28 KB

README.md

File metadata and controls

212 lines (149 loc) · 8.28 KB
Raw

humble iron jazzy rolling

ros2ai 🤖

ros2ai is a next-generation ROS 2 command line interface extension with OpenAI and Ollama.

see overview slide deck for more information.

ros2ai Architecture Overview

Motivation

  • (Just for fun 😝)
  • Getting answers against the questions directly without browsing, clicking and typing many times.
  • Easy to use for everyone, especially for ROS 2 beginners and students who do not really know ros2cli.
  • Multiple language support.
  • Multiple LLMs support (with OpenAI Python API)

Demo 🖥️

See how it works 🔥

demo.mp4

Supported ROS Distribution

Distribution Supported Note
Rolling Ridley ✅ Development / Mainstream Branch
Jazzy Jalisco ✅
Iron Irwini ✅
Humble Hawksbill ✅

Installation

Docker Container

see available images for tomoyafujita/ros2ai@dockerhub

docker run -it --rm --net=host -e OPENAI_API_KEY=$OPENAI_API_KEY tomoyafujita/ros2ai:humble

Note

OPENAI_API_KEY environmental variable is not required if using Ollama. And it is expecting that Ollama runs on the host system mostly, so that container is bound to the host network interface.

demo_docker.mp4

Required Package

  • rolling / jazzy

    pip install openai ollama validators --break-system-packages

    [!NOTE] see [PEP 668 – Marking Python base environments as “externally managed”](PEP 668 – Marking Python base environments as “externally managed”) why --break-system-packages is required.

  • iron / humble

    pip install openai ollama validators

Build

No released package is available, needs to be build in colcon workspace.

source /opt/ros/rolling/setup.bash
mkdir -p colcon_ws/src
cd colcon_ws/src
git clone https://github.com/fujitatomoya/ros2ai.git
cd ..
colcon build --symlink-install --packages-select ros2ai

Usage

Prerequisites

As described in overview diagram, ros2ai uses only OpenAI Python API but backend implementation can be replaced with Ollama that provides the compatible API with OpenAI. User need to choose either of them is used by ros2ai as following configuration, otherwise it falls back to use OpenAI.

  • OpenAI

    ros2ai requires OpenAI API key

    export OPENAI_API_KEY='your-api-key-here'

    [!CAUTION] Do not share or expose your OpenAI API key.

  • Ollama

    ros2ai requires Ollama service running, see more details for How to install Ollama to Linux

    ### Install Ollama and System Service
sudo curl -fsSL https://ollama.com/install.sh | sh
### Check ollama.service is up and running
systemctl status ollama
### Pull llama3.1 (for example) model
ollama pull llama3.1
### List available models
ollama list

Optional

environmental variable default Note
OPENAI_API_KEY None. Required for OpenAI
OPENAI_MODEL_NAME 'gpt-4o' AI model to be used. e.g) llama3.1 (Ollama)
OPENAI_ENDPOINT 'https://api.openai.com/v1' API endpoint URL. e.g) http://localhost:11434/v1 (Ollama)
OPENAI_TEMPERATURE 0.5 OpenAI temperature

Note

These are optional environmental variables. if not set, default value will be used.

Examples

Basics

  • configuration

    ### OpenAI configuration
export OPENAI_API_KEY=<YOUR_API_KEY>
export OPENAI_MODEL_NAME=gpt-4
export OPENAI_ENDPOINT=https://api.openai.com/v1

### Ollama
unset OPENAI_API_KEY
export OPENAI_MODEL_NAME=llama3.1
export OPENAI_ENDPOINT=http://localhost:11434/v1

  • status to check OpenAI API key is valid.

    root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai status -v
----- api_model: gpt-4
----- api_endpoint: https://api.openai.com/v1
----- api_token: None
As an artificial intelligence, I do not have a physical presence, so I can't be "in service" in the traditional sense. But I am available to assist you 24/7.
[SUCCESS] Valid OpenAI API key.

  • query to ask any questions to ROS 2 assistant.

    root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai query "Tell me how to check the available topics?"
To check the available topics in ROS 2, you can use the following command in the terminal:

---
ros2 topic list
---

After you enter this command, a list of all currently active topics in your ROS2 system will be displayed. This list includes all topics that nodes in your system are currently publishing to or subscribing from.

  • exec that ROS 2 assistant can execute the appropriate command based on your request.

    root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai exec "give me all nodes"
/talker
root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai exec "what topics available"
/chatter
/parameter_events
/rosout
root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai exec "give me detailed info for topic /chatter"
Type: std_msgs/msg/String
Publisher count: 1
Subscription count: 0

Multiple Language

  • Japanese (could be any language ❓)

    root@tomoyafujita:~/docker_ws/ros2_colcon# ros2 ai query "パラメータのリスト取得方法を教えて"
ROS 2のパラメータリストを取得するには、コマンドラインインターフェース(CLI)を使います。具体的には、次のコマンドを使用します：

---code
ros2 param list
---

このコマンドは、現在動作しているすべてのノードのパラメーターをリストアップします。特定のノードのパラメータだけを見たい場合には、以下のようにノード名を指定することもできます。

---code
ros2 param list /node_name
---

このようにして、ROS2のパラメータリストの取得を行うことが可能です。なお、上述したコマンドはシェルから直接実行してください。

Reference

Special thanks to OpenAI API and Ollama 🌟🌟🌟