From 7efd46d09debbb59c934af0ac2af553bcb2ab1aa Mon Sep 17 00:00:00 2001 From: Maciej Majek Date: Thu, 5 Sep 2024 22:26:39 +0200 Subject: [PATCH] chore: remove corrupted file --- docs/demos.md.orig | 107 --------------------------------------------- 1 file changed, 107 deletions(-) delete mode 100644 docs/demos.md.orig diff --git a/docs/demos.md.orig b/docs/demos.md.orig deleted file mode 100644 index e17508401..000000000 --- a/docs/demos.md.orig +++ /dev/null @@ -1,107 +0,0 @@ -# Demos - -RAI comes with a number of supported demos, which showcase different applications, but are by no means exhaustive. - -![demos.png](imgs/demos.png) - -## Installation - -In the root directory of the `rai` repo, run the following command to fetch demo repositories: - -```bash -vcs import < demos.repos -``` - -<<<<<<< HEAD -## Husarion ROSBot XL demo - -![Screenshot1](imgs/o3deSimulation.png) - -### Using pre-bulit binary - -1. Download the newest binary release (`release.zip` file) from [rai-rosbot-xl-demo -> releases](https://github.com/RobotecAI/rai-rosbot-xl-demo/releases) -2. Install required packages - - ```bash - sudo apt install ros-${ROS_DISTRO}-ackermann-msgs ros-${ROS_DISTRO}-gazebo-msgs ros-${ROS_DISTRO}-control-toolbox - ``` - -3. Unpack the binary and run the simulation: - - ```bash - unzip release.zip - . /opt/ros/${ROS_DISTRO}/setup.bash - ./release/RAIRosbotXLDemo.GameLauncher -bg_ConnectToAssetProcessor=0 - ``` - -4. Start navigation stack: - ```bash - ./src/examples/rai-rosbot-xl-demo/run-nav.sh - ``` - -### Building the project yourself - -If you would like to adapt the simulation to your needs, you can make changes using -[O3DE Editor](https://www.docs.o3de.org/docs/welcome-guide/) and build the project -yourself. -Please refer to [rai husarion rosbot xl demo][rai rosbot demo] for more details. - -## Running RAI - -You can set the task for the agent in the `examples/nav2_example_ros_actions.py` file. - -1. Prepare the robot description. - -```bash -colcon build --symlink-install --packages-select rosbot_xl_whoami - -. install/setup.bash -``` - -2. Start `rai_whoami_node` - who_am_i node. It loads files from robot [description](https://github.com/RobotecAI/rai-rosbot-xl-demo/tree/development/src/rosbot_xl_whoami/description) folder to server robot identity. - -```bash -source setup_shell.sh - -ros2 run rai_whoami rai_whoami_node --ros-args -p robot_description_package:="rosbot_xl_whoami" -``` - -3. Start `rai_node`. - -By looking at the example code in `src/examples/rosbot-xl-generic-node-demo.py` you can see that: - -- This node has no information about the robot besides what it can get from `rai_whoami_node` -- Topics can be whitelisted to only receive information about the robot -- Before every LLM decision, `rai_node` sends it's state to the LLM Agent. By default it contains ros interfaces (topics, services, actions) and rosout summary, but state can be extended. In the example we also adding the summary of the camera image. - -```bash -source setup_shell.sh - -python examples/rosbot-xl-generic-node-demo.py -``` - -4. Send the task to the node: - -> **NOTE**: For now agent is capable of performing only 1 task at once. - -```bash -# Using robots camera to describe environment -ros2 topic pub --once /task_addition_requests std_msgs/msg/String "data: 'Where are you now?'" - -# Automatic integration with navigation stack -ros2 topic pub --once /task_addition_requests std_msgs/msg/String "data: 'Drive 1 meter forward'" -ros2 topic pub --once /task_addition_requests std_msgs/msg/String "data: 'Spin 90 degrees'" - -# Knowledge composition to achieve more complicated tasks -ros2 topic pub --once /task_addition_requests std_msgs/msg/String "data: 'Drive forward if the path is clear, otherwise backward'" -``` - -[rai rosbot demo]: https://github.com/RobotecAI/rai-rosbot-xl-demo -======= -Once you have all the demos pulled, see dedicated docs to proceed: -- [Husarion ROSBot XL in an apartment](demos/rosbot_xl.md) -- Coming soon - autonomous tractor in an orchard. -- Coming soon - inspection with ANYmal robot dog. -- Coming soon - manipulation tasks demo ->>>>>>> 50e2de4 (docs improvements)