From 720d3ec0d8066a5aecec3bffd3d91ca30e3fbfea Mon Sep 17 00:00:00 2001 From: YuZhong-Chen Date: Fri, 27 Sep 2024 17:31:01 +0800 Subject: [PATCH] Update documentation --- _sources/introduction/quick_start.rst.txt | 5 +++-- introduction/quick_start.html | 5 +++-- searchindex.js | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/_sources/introduction/quick_start.rst.txt b/_sources/introduction/quick_start.rst.txt index 171e840..5c50aa6 100644 --- a/_sources/introduction/quick_start.rst.txt +++ b/_sources/introduction/quick_start.rst.txt @@ -30,11 +30,12 @@ start the Gazebo simulation with the Kobuki robot. 4. Generate the 3D Scene Graph by Hydra In the ``hydra_ws`` directory, use the command ``docker compose run --rm --build hydra-ws-build`` to build the environment. -After the environment is built, use the command below to generate the 3D scene graph:: +After the environment is built, use the command ``docker compose run --rm hydra-ws`` to run the container, +and use the command below to generate the 3D scene graph:: cd ~/catkin_ws source devel/setup.bash - roslaunch hydra_ros uhumans2.launch + roslaunch hydra_ros uhumans2.launch zmq_ip:=127.0.0.1 5. Use keyboard teleoperation to move the robot in Gazebo:: diff --git a/introduction/quick_start.html b/introduction/quick_start.html index 234f43b..9165418 100644 --- a/introduction/quick_start.html +++ b/introduction/quick_start.html @@ -132,10 +132,11 @@

4. Quick start

Generate the 3D Scene Graph by Hydra

In the hydra_ws directory, use the command docker compose run --rm --build hydra-ws-build to build the environment. -After the environment is built, use the command below to generate the 3D scene graph:

+After the environment is built, use the command docker compose run --rm hydra-ws to run the container, +and use the command below to generate the 3D scene graph:

cd ~/catkin_ws
 source devel/setup.bash
-roslaunch hydra_ros uhumans2.launch
+roslaunch hydra_ros uhumans2.launch zmq_ip:=127.0.0.1
    diff --git a/searchindex.js b/searchindex.js index 9fe8388..ae24f4d 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Architecture": [[14, null]], "Basic ROS2 CLI Commands": [[17, "basic-ros2-cli-commands"]], "Building docker image": [[0, "building-docker-image"], [2, "building-docker-image"], [3, "building-docker-image"], [4, "building-docker-image"], [8, "building-docker-image"]], "Building the workspace": [[0, "building-the-workspace"], [2, "building-the-workspace"], [4, "building-the-workspace"]], "Cartographer Workspace": [[0, null]], "CodeBase": [[10, null]], "CodeBase Overview": [[1, null]], "Core Features of ROS2": [[17, "core-features-of-ros2"]], "Demo": [[9, null], [10, null]], "Devcontainer": [[11, null]], "Docker": [[12, null]], "Features": [[15, "features"]], "Gazebo": [[9, "gazebo"]], "Gazebo World Workspace": [[2, null]], "Habitat Sim": [[9, "habitat-sim"]], "Hardware": [[14, "hardware"]], "Hydra Workspace": [[3, null]], "Installation": [[10, null]], "Introduction": [[10, null], [15, null], [15, "id1"]], "Kobuki Workspace": [[4, null]], "LLM Query Workspace": [[5, null]], "LLM-Navigation documentation": [[10, null]], "Links": [[10, "links"]], "Quick start": [[4, "quick-start"], [16, null]], "ROS1 Bridge Workspace": [[7, null]], "ROS2": [[17, null]], "ROS2 Humble": [[13, null]], "Realsense Workspace": [[6, null]], "Run bridge with prebuilt image": [[7, "run-bridge-with-prebuilt-image"]], "Run the gazebo worlds": [[2, "run-the-gazebo-worlds"]], "Run the gazebo worlds with turtlebot3": [[2, "run-the-gazebo-worlds-with-turtlebot3"]], "Running hydra with default settings": [[3, "running-hydra-with-default-settings"]], "Simple test": [[0, "simple-test"]], "Simple test in Gazebo": [[4, "simple-test-in-gazebo"]], "Simple test on real robot": [[4, "simple-test-on-real-robot"]], "Software": [[14, "software"]], "Target worlds": [[2, "target-worlds"]], "Test in simulation environment": [[8, "test-in-simulation-environment"]], "Test on real robot": [[8, "test-on-real-robot"]], "VLP-16 LiDAR Workspace": [[8, null]], "What is ROS?": [[17, "what-is-ros"]], "Why Use ROS2?": [[17, "why-use-ros2"]]}, "docnames": ["codebase/cartographer_ws", "codebase/codebase_overview", "codebase/gazebo_world_ws", "codebase/hydra_ws", "codebase/kobuki_ws", "codebase/llm_query_ws", "codebase/realsense_ws", "codebase/ros1_bridge_ws", "codebase/vlplidar_ws", "demo/demo", "index", "installation/devcontainer", "installation/docker", "installation/ros2", "introduction/architecture", "introduction/introduction", "introduction/quick_start", "introduction/ros2"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["codebase/cartographer_ws.rst", "codebase/codebase_overview.rst", "codebase/gazebo_world_ws.rst", "codebase/hydra_ws.rst", "codebase/kobuki_ws.rst", "codebase/llm_query_ws.rst", "codebase/realsense_ws.rst", "codebase/ros1_bridge_ws.rst", "codebase/vlplidar_ws.rst", "demo/demo.rst", "index.rst", "installation/devcontainer.rst", "installation/docker.rst", "installation/ros2.rst", "introduction/architecture.rst", "introduction/introduction.rst", "introduction/quick_start.rst", "introduction/ros2.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [14, 15], "0755": 12, "16": [1, 10], "2": 13, "2d": 14, "3": 15, "3d": [4, 10, 14, 15, 16], "3dsg": 15, "A": 15, "As": 17, "For": [0, 2, 3, 4, 7, 8, 11, 12, 13, 15, 17], "If": [10, 11, 16], "In": [0, 14, 15, 16], "It": [11, 17], "Or": 11, "The": [4, 11, 14, 15, 16], "Then": 16, "There": 15, "These": 17, "To": [1, 12, 16, 17], "abil": 15, "abl": 16, "about": [11, 12, 13, 17], "abov": 16, "accord": 16, "achiev": 17, "across": [15, 17], "act": 15, "action": 17, "activ": 17, "actual": 16, "adapt": 3, "add": [12, 13], "addition": 15, "address": 15, "adjust": 16, "adopt": 17, "after": 16, "again": 12, "agent": [2, 15], "agricultur": 17, "aim": 15, "all": [1, 12, 17], "allow": [11, 17], "along": 1, "alreadi": 13, "amd": [14, 15], "an": [10, 15, 17], "ani": [10, 11], "anoth": 0, "anyon": 17, "applic": 17, "approach": 15, "appropri": 15, "apt": [12, 13], "ar": [2, 15, 17], "arch": [12, 13], "architectur": [10, 12, 13, 15, 16, 17], "archiv": 13, "area": 15, "asc": 12, "attach": [0, 2, 4, 8], "attribut": 14, "author": 10, "autonom": 17, "avoid": 15, "aws_hospit": 2, "aws_small_hous": 2, "back": 14, "base": [1, 12, 15, 16, 17], "bash": [0, 2, 3, 13, 16], "bashrc": 13, "basic": [10, 14], "bed": 14, "befor": 16, "below": [1, 11, 16], "better": [1, 12, 16, 17], "between": [1, 7, 15, 17], "both": [2, 17], "bridg": 10, "brief": 1, "bring": [1, 16], "bringup": [4, 8], "build": [10, 14, 16, 17], "builder": 14, "buildx": 12, "built": 16, "burger": 0, "ca": 12, "camera": [1, 14], "can": [11, 15, 17], "capabl": [15, 17], "cartograph": [1, 10], "cartographer_ro": 0, "cartographer_w": [0, 1], "case": [13, 15], "catkin_w": [3, 16], "cd": [0, 2, 3, 4, 7, 8, 16], "ce": 12, "certif": 12, "challeng": 15, "chen": [0, 2, 3, 4, 7, 8, 16], "chmod": 12, "citysim": 2, "clear": 17, "cli": [10, 12], "clone": [0, 2, 3, 4, 7, 8, 16], "code": [1, 11, 12], "codebas": [0, 5, 6, 8, 13, 16], "colcon": [0, 2, 4], "com": [0, 2, 3, 4, 7, 8, 10, 12, 13, 16], "command": [10, 16], "common": [12, 13], "commun": 17, "compani": 17, "compar": 15, "compat": 17, "compil": [2, 4], "complet": [1, 12], "complex": [14, 17], "compon": [14, 15, 17], "compos": [0, 1, 2, 3, 4, 7, 8, 11, 12, 16], "comprehend": 16, "comput": [4, 14, 16], "configur": [4, 16], "connect": 4, "consequ": 15, "consist": 14, "constraint": 17, "construct": [14, 15], "contact": 10, "contain": [0, 2, 3, 4, 5, 6, 8, 11, 16], "container": 11, "containerd": 12, "control": [0, 4, 14, 17], "convert": 14, "core": [10, 14, 15], "costmap": 14, "creat": [7, 10, 16, 17], "cross": 17, "crucial": 17, "curl": [12, 13], "current": 15, "custom": 17, "d": [0, 2, 4, 8, 12, 13], "data": [14, 17], "date": 13, "dd": 17, "deb": [12, 13], "default": 10, "defin": 17, "demonstr": 16, "depend": [0, 12], "deploi": 17, "descript": 14, "design": [12, 15, 17], "desir": 14, "desktop": 13, "detail": [0, 2, 3, 4, 7, 8, 14, 15], "determinist": 17, "dev": [12, 13], "devcontain": 10, "devel": [3, 16], "develop": [11, 17], "devic": 17, "differ": [14, 15, 17], "difficult": 15, "direct": 14, "directori": 16, "distribut": 17, "divers": [15, 17], "divid": [1, 17], "do": 13, "docker": [1, 7, 10, 11, 13, 16], "dockerfil": [11, 13, 16], "download": [12, 13], "dpkg": [12, 13], "driver": [4, 8], "drone": 17, "due": [14, 15, 16], "dure": 15, "each": [1, 16, 17], "easi": 17, "echo": [12, 13, 17], "edg": 15, "effici": 14, "email": 10, "emploi": 14, "enabl": [14, 17], "encod": 14, "enhanc": [15, 16], "ensur": [1, 12, 13, 17], "entir": 12, "env": 16, "environ": [0, 1, 2, 4, 10, 11, 12, 13, 14, 15, 16, 17], "especi": 17, "essenti": [0, 2, 4, 8], "etc": [12, 13], "evolut": 17, "exampl": [8, 15], "except": 13, "exchang": 1, "exec": 8, "execut": 14, "exist": 17, "export": 0, "extens": 11, "face": 15, "facilit": [4, 15], "fast": 17, "feasibl": 15, "featur": [10, 13], "few": 13, "field": 15, "file": [0, 2, 4, 7, 8, 14, 17], "final": 14, "finish": 16, "fleet": 17, "flexibl": [15, 17], "floor": 15, "focus": 17, "folder": 11, "follow": [4, 12, 13, 14], "format": 15, "forward": 15, "found": 15, "four": 14, "framework": 17, "friendli": 15, "from": [0, 3, 11, 14, 15], "fssl": 12, "full": [11, 13], "fulli": 16, "function": [1, 12], "fundament": 17, "further": 15, "gazebo": [1, 10, 16], "gazebo_launch": 2, "gazebo_rl_env": [4, 16], "gazebo_world": 2, "gazebo_world_w": [1, 2], "gener": [1, 13, 16], "get": [12, 17], "git": [0, 2, 3, 4, 7, 8, 16], "github": [0, 2, 3, 4, 7, 8, 10, 16], "githubusercont": 13, "given": 15, "gmail": 10, "go": [14, 15], "goal": [14, 15], "gpg": [12, 13], "graph": [1, 4, 10, 14, 15, 16], "guid": [4, 15, 16], "ha": 15, "habitat": 10, "hackster": 10, "handl": 17, "hardwar": [10, 17], "have": [1, 10, 12, 13, 16], "healthcar": 17, "help": 16, "here": 17, "heterogen": 17, "hierarch": [14, 15], "high": [14, 17], "hobbyist": 17, "home": [0, 2, 4, 8], "host": 14, "howev": [15, 16], "http": [0, 2, 3, 4, 7, 8, 12, 13, 16], "human": 15, "humbl": [0, 1, 7, 10, 17], "hydra": [10, 15, 16], "hydra_ro": [3, 16], "hydra_w": [1, 3, 16], "i": [1, 3, 4, 7, 10, 11, 13, 14, 15, 16], "ideal": 17, "identifi": 14, "ignor": 0, "imag": [10, 14, 15], "implement": 14, "improv": 17, "includ": [14, 15, 17], "index": 12, "indoor": 2, "industri": 17, "info": 17, "inform": [3, 11, 12, 13, 17], "initi": 15, "input": [14, 15], "insight": 15, "inspect": 17, "instal": [0, 2, 4, 11, 12, 13], "instruct": [14, 15], "integr": 15, "intel": [1, 6], "interact": [14, 17], "interfac": [14, 15, 17], "interpret": 14, "introduc": [14, 17], "introduct": 1, "intuit": 15, "io": [10, 12], "is_sim": [4, 8], "isol": 11, "issu": 10, "its": [14, 15], "kei": [12, 13, 17], "keyboard": 16, "keyr": [12, 13], "kobuki": [1, 10, 14, 16], "kobuki_launch": 4, "kobuki_w": [1, 4, 16], "kr260": [14, 15], "label": 14, "languag": [14, 15], "larg": [14, 15, 17], "later": 14, "launch": [0, 2, 3, 4, 8, 16, 17], "launch_fil": 17, "layer": 17, "learn": 15, "level": [14, 15], "leverag": 17, "librari": 17, "lidar": [1, 10, 14], "like": 15, "limit": 15, "line": 17, "link": 11, "linux": [12, 17], "list": [1, 12, 13, 17], "llm": [0, 1, 2, 3, 4, 7, 8, 14, 15, 16], "llm_query_w": 1, "load": 14, "local": [0, 14, 15], "locat": [1, 14, 15], "logist": 17, "low": 14, "m": 12, "machin": 17, "maco": 17, "mai": 16, "main": [13, 14, 15], "maintain": [12, 17], "mainten": 1, "major": 17, "make": [4, 15, 16, 17], "manual": [13, 16], "manufactur": 17, "map": [0, 15], "marketplac": 11, "master": 13, "md": [0, 2, 4, 7, 8], "mean": 15, "mechan": 17, "meet": 17, "mental": 15, "messag": [1, 17], "message_data": 17, "message_typ": 17, "method": 15, "middlewar": 17, "mind": 17, "model": 14, "modifi": 16, "modul": [14, 15, 17], "modular": 17, "more": [0, 2, 3, 4, 7, 8, 11, 12, 13, 15, 17], "moreov": 15, "move": 16, "movement": 14, "multi": 17, "multipl": [1, 12, 14, 15, 17], "name": 2, "natur": 15, "navig": [0, 1, 2, 3, 4, 7, 8, 12, 14, 15, 16], "necessari": [1, 12], "need": [1, 12, 13, 16, 17], "network": 17, "node": [15, 17], "node_nam": 17, "noetic": 1, "noisi": 15, "normal": [1, 12], "note": 13, "null": [12, 13], "o": [12, 13], "object": [14, 15], "observ": 15, "obstacl": 15, "odometri": 14, "offer": [15, 17], "offici": [11, 12, 13, 17], "onli": [1, 11, 12, 13], "open": [0, 11, 15], "oper": [15, 17], "opt": 13, "option": 0, "order": 16, "org": 13, "organ": 15, "origin": 3, "other": 17, "our": [1, 12, 13, 14, 15, 16], "outdoor": 2, "output": 15, "overview": [10, 16], "own": 13, "packag": [1, 12, 13], "package_nam": 17, "paper": 3, "paragraph": 14, "particularli": 17, "path": [0, 15], "perform": [15, 17], "pipelin": 15, "place": 15, "platform": 17, "pleas": [0, 2, 3, 4, 7, 8, 10, 11, 12, 13, 16, 17], "plugin": 12, "point": [14, 15], "possibl": 16, "power": 14, "prebuilt": 10, "predict": 17, "present": 15, "press": 11, "previous": 15, "primarili": 3, "print": [12, 13], "process": [4, 14, 15, 16], "project": [0, 4, 10], "properti": [12, 13], "propos": 15, "proven": 15, "provid": [11, 15, 16, 17], "pub": 17, "publish": 17, "pull": [0, 2, 3, 4, 7, 8], "purpos": 16, "py": [0, 2, 4, 8, 16], "queri": [1, 10, 14, 15], "question": 10, "quick": 10, "r": 12, "raw": 13, "read": [3, 16], "readabl": 15, "readm": [0, 2, 4, 7, 8], "real": [1, 10, 15, 16, 17], "realsens": [1, 10, 14], "realsense_ros1_w": 1, "reason": [15, 17], "receiv": 14, "refer": [0, 2, 3, 4, 7, 8], "region": 14, "reinforc": 15, "relationship": [14, 15], "releas": [12, 13], "reliabl": 17, "remot": 14, "replac": 2, "repositori": [0, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 16], "repres": [14, 15], "reproduct": 16, "requir": [12, 17], "research": [15, 17], "respons": [15, 17], "return": 14, "reus": 17, "reward": 15, "rgbd": [14, 15], "rl": 15, "rl_env": [4, 16], "rm": [3, 16], "ro": [10, 13, 15], "robot": [0, 1, 2, 10, 14, 15, 16, 17], "robust": 17, "ros1": [1, 10, 17], "ros1_bridg": 16, "ros1_bridge_w": [1, 7, 16], "ros2": [0, 1, 2, 4, 7, 8, 10, 16], "ros_hostnam": 16, "ros_master_uri": 16, "rosdep": 0, "rosdistro": [0, 13], "roslaunch": [3, 16], "rqt_robot_st": 0, "run": [0, 4, 10, 16], "rviz": 16, "same": 17, "scalabl": 17, "scale": 17, "scene": [1, 4, 10, 14, 15, 16], "screenshot": 16, "script": [4, 8], "section": 16, "see": [16, 17], "segment": [14, 15], "semant": [14, 15], "send": 14, "sensor": [14, 15], "serv": [14, 15], "server": [14, 15], "servic": 17, "session": 0, "set": [0, 4, 5, 6, 8, 10, 13, 15, 16, 17], "setup": [0, 1, 2, 3, 12, 13, 16], "sever": [2, 15, 17], "sg": 14, "sh": [4, 8], "share": 13, "shell": 13, "should": [15, 16], "sign": [12, 13], "signal": [14, 15], "significantli": 15, "sim": 10, "simpl": [10, 17], "simplifi": 16, "simul": [0, 4, 10, 16], "skip": 11, "slam": [0, 1, 8, 14], "sleep": 15, "softwar": [10, 12, 13, 17], "some": [16, 17], "sourc": [0, 2, 3, 12, 13, 16], "sparsiti": 15, "spatial": 14, "specif": [15, 17], "specifi": [1, 15], "split": 12, "src": 0, "ssl": 13, "stabl": 12, "standard": 17, "start": [10, 17], "step": [4, 11, 12, 13, 16], "structur": [15, 17], "studi": 15, "studio": 11, "sudo": [12, 13], "suggest": 15, "suit": 17, "suitabl": 17, "support": [15, 17], "sure": [4, 16], "symlink": [2, 4], "sync": 17, "system": [12, 13, 15, 17], "target": 10, "task": [14, 15, 17], "team": 17, "tee": [12, 13], "teleop": 4, "teleop_twist_keyboard": 16, "teleoper": 16, "test": [2, 10, 17], "thei": 17, "them": [14, 17], "thi": [0, 2, 3, 4, 5, 6, 7, 8, 11, 15, 16, 17], "those": 17, "through": 4, "time": [1, 15, 17], "tmux": 0, "togeth": [14, 17], "tool": 17, "topic": 17, "topic_nam": 17, "toward": 15, "tradit": 15, "train": 15, "transfer": 17, "transit": 15, "transport": 12, "travers": 15, "true": [4, 8], "turtlebot3": 10, "turtlebot3_gazebo": 0, "turtlebot3_model": 0, "turtlebot3_world": 0, "ubuntu": [12, 13], "ubuntu_codenam": 13, "uhumans2": [3, 16], "understand": [14, 15, 16], "univers": 13, "unlik": 17, "unseen": 15, "unstabl": 15, "up": [0, 1, 2, 4, 5, 6, 7, 8, 12, 13, 16, 17], "updat": [0, 12, 13, 15], "upgrad": 13, "us": [0, 1, 10, 11, 12, 14, 15, 16], "user": 15, "usr": 13, "util": [7, 14], "valuabl": [2, 15], "variabl": 13, "variat": 16, "variou": [14, 15, 17], "vehicl": 17, "velodyne_descript": 8, "verifi": 12, "versatil": 17, "version": [12, 13], "version_codenam": 12, "view": 17, "visit": [11, 12, 13, 17], "visual": 11, "vlp": [1, 10], "vlp16": 14, "vlp_cartograph": 8, "vlp_driver": 8, "vlp_w": [1, 8], "volum": 17, "vscode": 11, "w": [0, 2, 3, 4, 8, 16], "want": [11, 13, 14, 15, 16], "we": [0, 1, 12, 13, 14, 15, 16], "websit": [11, 12, 13, 17], "well": 17, "what": 10, "wheel": 14, "when": 13, "where": [15, 17], "whether": 17, "which": [2, 14, 15, 17], "why": 10, "window": 17, "wish": 2, "within": [0, 13, 15], "work": [14, 17], "workspac": [1, 10, 12], "world": [1, 4, 8, 10, 15], "y": [0, 13], "yaml": 14, "you": [1, 2, 4, 10, 11, 12, 13, 16, 17], "your": [12, 13, 16], "yourself": 13, "yuzhong": [0, 2, 3, 4, 7, 8, 16], "yuzhong1214": 10}, "titles": ["2. Cartographer Workspace", "1. CodeBase Overview", "3. Gazebo World Workspace", "4. Hydra Workspace", "5. Kobuki Workspace", "6. LLM Query Workspace", "7. Realsense Workspace", "8. ROS1 Bridge Workspace", "9. VLP-16 LiDAR Workspace", "1. Demo", "LLM-Navigation documentation", "2. Devcontainer", "1. Docker", "3. ROS2 Humble", "2. Architecture", "1. Introduction", "4. Quick start", "3. ROS2"], "titleterms": {"16": 8, "architectur": 14, "basic": 17, "bridg": 7, "build": [0, 2, 3, 4, 8], "cartograph": 0, "cli": 17, "codebas": [1, 10], "command": 17, "core": 17, "default": 3, "demo": [9, 10], "devcontain": 11, "docker": [0, 2, 3, 4, 8, 12], "document": 10, "environ": 8, "featur": [15, 17], "gazebo": [2, 4, 9], "habitat": 9, "hardwar": 14, "humbl": 13, "hydra": 3, "i": 17, "imag": [0, 2, 3, 4, 7, 8], "instal": 10, "introduct": [10, 15], "kobuki": 4, "lidar": 8, "link": 10, "llm": [5, 10], "navig": 10, "overview": 1, "prebuilt": 7, "queri": 5, "quick": [4, 16], "real": [4, 8], "realsens": 6, "ro": 17, "robot": [4, 8], "ros1": 7, "ros2": [13, 17], "run": [2, 3, 7], "set": 3, "sim": 9, "simpl": [0, 4], "simul": 8, "softwar": 14, "start": [4, 16], "target": 2, "test": [0, 4, 8], "turtlebot3": 2, "us": 17, "vlp": 8, "what": 17, "why": 17, "workspac": [0, 2, 3, 4, 5, 6, 7, 8], "world": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Architecture": [[14, null]], "Basic ROS2 CLI Commands": [[17, "basic-ros2-cli-commands"]], "Building docker image": [[0, "building-docker-image"], [2, "building-docker-image"], [3, "building-docker-image"], [4, "building-docker-image"], [8, "building-docker-image"]], "Building the workspace": [[0, "building-the-workspace"], [2, "building-the-workspace"], [4, "building-the-workspace"]], "Cartographer Workspace": [[0, null]], "CodeBase": [[10, null]], "CodeBase Overview": [[1, null]], "Core Features of ROS2": [[17, "core-features-of-ros2"]], "Demo": [[9, null], [10, null]], "Devcontainer": [[11, null]], "Docker": [[12, null]], "Features": [[15, "features"]], "Gazebo": [[9, "gazebo"]], "Gazebo World Workspace": [[2, null]], "Habitat Sim": [[9, "habitat-sim"]], "Hardware": [[14, "hardware"]], "Hydra Workspace": [[3, null]], "Installation": [[10, null]], "Introduction": [[10, null], [15, null], [15, "id1"]], "Kobuki Workspace": [[4, null]], "LLM Query Workspace": [[5, null]], "LLM-Navigation documentation": [[10, null]], "Links": [[10, "links"]], "Quick start": [[4, "quick-start"], [16, null]], "ROS1 Bridge Workspace": [[7, null]], "ROS2": [[17, null]], "ROS2 Humble": [[13, null]], "Realsense Workspace": [[6, null]], "Run bridge with prebuilt image": [[7, "run-bridge-with-prebuilt-image"]], "Run the gazebo worlds": [[2, "run-the-gazebo-worlds"]], "Run the gazebo worlds with turtlebot3": [[2, "run-the-gazebo-worlds-with-turtlebot3"]], "Running hydra with default settings": [[3, "running-hydra-with-default-settings"]], "Simple test": [[0, "simple-test"]], "Simple test in Gazebo": [[4, "simple-test-in-gazebo"]], "Simple test on real robot": [[4, "simple-test-on-real-robot"]], "Software": [[14, "software"]], "Target worlds": [[2, "target-worlds"]], "Test in simulation environment": [[8, "test-in-simulation-environment"]], "Test on real robot": [[8, "test-on-real-robot"]], "VLP-16 LiDAR Workspace": [[8, null]], "What is ROS?": [[17, "what-is-ros"]], "Why Use ROS2?": [[17, "why-use-ros2"]]}, "docnames": ["codebase/cartographer_ws", "codebase/codebase_overview", "codebase/gazebo_world_ws", "codebase/hydra_ws", "codebase/kobuki_ws", "codebase/llm_query_ws", "codebase/realsense_ws", "codebase/ros1_bridge_ws", "codebase/vlplidar_ws", "demo/demo", "index", "installation/devcontainer", "installation/docker", "installation/ros2", "introduction/architecture", "introduction/introduction", "introduction/quick_start", "introduction/ros2"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["codebase/cartographer_ws.rst", "codebase/codebase_overview.rst", "codebase/gazebo_world_ws.rst", "codebase/hydra_ws.rst", "codebase/kobuki_ws.rst", "codebase/llm_query_ws.rst", "codebase/realsense_ws.rst", "codebase/ros1_bridge_ws.rst", "codebase/vlplidar_ws.rst", "demo/demo.rst", "index.rst", "installation/devcontainer.rst", "installation/docker.rst", "installation/ros2.rst", "introduction/architecture.rst", "introduction/introduction.rst", "introduction/quick_start.rst", "introduction/ros2.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [14, 15], "0": 16, "0755": 12, "1": 16, "127": 16, "16": [1, 10], "2": 13, "2d": 14, "3": 15, "3d": [4, 10, 14, 15, 16], "3dsg": 15, "A": 15, "As": 17, "For": [0, 2, 3, 4, 7, 8, 11, 12, 13, 15, 17], "If": [10, 11, 16], "In": [0, 14, 15, 16], "It": [11, 17], "Or": 11, "The": [4, 11, 14, 15, 16], "Then": 16, "There": 15, "These": 17, "To": [1, 12, 16, 17], "abil": 15, "abl": 16, "about": [11, 12, 13, 17], "abov": 16, "accord": 16, "achiev": 17, "across": [15, 17], "act": 15, "action": 17, "activ": 17, "actual": 16, "adapt": 3, "add": [12, 13], "addition": 15, "address": 15, "adjust": 16, "adopt": 17, "after": 16, "again": 12, "agent": [2, 15], "agricultur": 17, "aim": 15, "all": [1, 12, 17], "allow": [11, 17], "along": 1, "alreadi": 13, "amd": [14, 15], "an": [10, 15, 17], "ani": [10, 11], "anoth": 0, "anyon": 17, "applic": 17, "approach": 15, "appropri": 15, "apt": [12, 13], "ar": [2, 15, 17], "arch": [12, 13], "architectur": [10, 12, 13, 15, 16, 17], "archiv": 13, "area": 15, "asc": 12, "attach": [0, 2, 4, 8], "attribut": 14, "author": 10, "autonom": 17, "avoid": 15, "aws_hospit": 2, "aws_small_hous": 2, "back": 14, "base": [1, 12, 15, 16, 17], "bash": [0, 2, 3, 13, 16], "bashrc": 13, "basic": [10, 14], "bed": 14, "befor": 16, "below": [1, 11, 16], "better": [1, 12, 16, 17], "between": [1, 7, 15, 17], "both": [2, 17], "bridg": 10, "brief": 1, "bring": [1, 16], "bringup": [4, 8], "build": [10, 14, 16, 17], "builder": 14, "buildx": 12, "built": 16, "burger": 0, "ca": 12, "camera": [1, 14], "can": [11, 15, 17], "capabl": [15, 17], "cartograph": [1, 10], "cartographer_ro": 0, "cartographer_w": [0, 1], "case": [13, 15], "catkin_w": [3, 16], "cd": [0, 2, 3, 4, 7, 8, 16], "ce": 12, "certif": 12, "challeng": 15, "chen": [0, 2, 3, 4, 7, 8, 16], "chmod": 12, "citysim": 2, "clear": 17, "cli": [10, 12], "clone": [0, 2, 3, 4, 7, 8, 16], "code": [1, 11, 12], "codebas": [0, 5, 6, 8, 13, 16], "colcon": [0, 2, 4], "com": [0, 2, 3, 4, 7, 8, 10, 12, 13, 16], "command": [10, 16], "common": [12, 13], "commun": 17, "compani": 17, "compar": 15, "compat": 17, "compil": [2, 4], "complet": [1, 12], "complex": [14, 17], "compon": [14, 15, 17], "compos": [0, 1, 2, 3, 4, 7, 8, 11, 12, 16], "comprehend": 16, "comput": [4, 14, 16], "configur": [4, 16], "connect": 4, "consequ": 15, "consist": 14, "constraint": 17, "construct": [14, 15], "contact": 10, "contain": [0, 2, 3, 4, 5, 6, 8, 11, 16], "container": 11, "containerd": 12, "control": [0, 4, 14, 17], "convert": 14, "core": [10, 14, 15], "costmap": 14, "creat": [7, 10, 16, 17], "cross": 17, "crucial": 17, "curl": [12, 13], "current": 15, "custom": 17, "d": [0, 2, 4, 8, 12, 13], "data": [14, 17], "date": 13, "dd": 17, "deb": [12, 13], "default": 10, "defin": 17, "demonstr": 16, "depend": [0, 12], "deploi": 17, "descript": 14, "design": [12, 15, 17], "desir": 14, "desktop": 13, "detail": [0, 2, 3, 4, 7, 8, 14, 15], "determinist": 17, "dev": [12, 13], "devcontain": 10, "devel": [3, 16], "develop": [11, 17], "devic": 17, "differ": [14, 15, 17], "difficult": 15, "direct": 14, "directori": 16, "distribut": 17, "divers": [15, 17], "divid": [1, 17], "do": 13, "docker": [1, 7, 10, 11, 13, 16], "dockerfil": [11, 13, 16], "download": [12, 13], "dpkg": [12, 13], "driver": [4, 8], "drone": 17, "due": [14, 15, 16], "dure": 15, "each": [1, 16, 17], "easi": 17, "echo": [12, 13, 17], "edg": 15, "effici": 14, "email": 10, "emploi": 14, "enabl": [14, 17], "encod": 14, "enhanc": [15, 16], "ensur": [1, 12, 13, 17], "entir": 12, "env": 16, "environ": [0, 1, 2, 4, 10, 11, 12, 13, 14, 15, 16, 17], "especi": 17, "essenti": [0, 2, 4, 8], "etc": [12, 13], "evolut": 17, "exampl": [8, 15], "except": 13, "exchang": 1, "exec": 8, "execut": 14, "exist": 17, "export": 0, "extens": 11, "face": 15, "facilit": [4, 15], "fast": 17, "feasibl": 15, "featur": [10, 13], "few": 13, "field": 15, "file": [0, 2, 4, 7, 8, 14, 17], "final": 14, "finish": 16, "fleet": 17, "flexibl": [15, 17], "floor": 15, "focus": 17, "folder": 11, "follow": [4, 12, 13, 14], "format": 15, "forward": 15, "found": 15, "four": 14, "framework": 17, "friendli": 15, "from": [0, 3, 11, 14, 15], "fssl": 12, "full": [11, 13], "fulli": 16, "function": [1, 12], "fundament": 17, "further": 15, "gazebo": [1, 10, 16], "gazebo_launch": 2, "gazebo_rl_env": [4, 16], "gazebo_world": 2, "gazebo_world_w": [1, 2], "gener": [1, 13, 16], "get": [12, 17], "git": [0, 2, 3, 4, 7, 8, 16], "github": [0, 2, 3, 4, 7, 8, 10, 16], "githubusercont": 13, "given": 15, "gmail": 10, "go": [14, 15], "goal": [14, 15], "gpg": [12, 13], "graph": [1, 4, 10, 14, 15, 16], "guid": [4, 15, 16], "ha": 15, "habitat": 10, "hackster": 10, "handl": 17, "hardwar": [10, 17], "have": [1, 10, 12, 13, 16], "healthcar": 17, "help": 16, "here": 17, "heterogen": 17, "hierarch": [14, 15], "high": [14, 17], "hobbyist": 17, "home": [0, 2, 4, 8], "host": 14, "howev": [15, 16], "http": [0, 2, 3, 4, 7, 8, 12, 13, 16], "human": 15, "humbl": [0, 1, 7, 10, 17], "hydra": [10, 15, 16], "hydra_ro": [3, 16], "hydra_w": [1, 3, 16], "i": [1, 3, 4, 7, 10, 11, 13, 14, 15, 16], "ideal": 17, "identifi": 14, "ignor": 0, "imag": [10, 14, 15], "implement": 14, "improv": 17, "includ": [14, 15, 17], "index": 12, "indoor": 2, "industri": 17, "info": 17, "inform": [3, 11, 12, 13, 17], "initi": 15, "input": [14, 15], "insight": 15, "inspect": 17, "instal": [0, 2, 4, 11, 12, 13], "instruct": [14, 15], "integr": 15, "intel": [1, 6], "interact": [14, 17], "interfac": [14, 15, 17], "interpret": 14, "introduc": [14, 17], "introduct": 1, "intuit": 15, "io": [10, 12], "is_sim": [4, 8], "isol": 11, "issu": 10, "its": [14, 15], "kei": [12, 13, 17], "keyboard": 16, "keyr": [12, 13], "kobuki": [1, 10, 14, 16], "kobuki_launch": 4, "kobuki_w": [1, 4, 16], "kr260": [14, 15], "label": 14, "languag": [14, 15], "larg": [14, 15, 17], "later": 14, "launch": [0, 2, 3, 4, 8, 16, 17], "launch_fil": 17, "layer": 17, "learn": 15, "level": [14, 15], "leverag": 17, "librari": 17, "lidar": [1, 10, 14], "like": 15, "limit": 15, "line": 17, "link": 11, "linux": [12, 17], "list": [1, 12, 13, 17], "llm": [0, 1, 2, 3, 4, 7, 8, 14, 15, 16], "llm_query_w": 1, "load": 14, "local": [0, 14, 15], "locat": [1, 14, 15], "logist": 17, "low": 14, "m": 12, "machin": 17, "maco": 17, "mai": 16, "main": [13, 14, 15], "maintain": [12, 17], "mainten": 1, "major": 17, "make": [4, 15, 16, 17], "manual": [13, 16], "manufactur": 17, "map": [0, 15], "marketplac": 11, "master": 13, "md": [0, 2, 4, 7, 8], "mean": 15, "mechan": 17, "meet": 17, "mental": 15, "messag": [1, 17], "message_data": 17, "message_typ": 17, "method": 15, "middlewar": 17, "mind": 17, "model": 14, "modifi": 16, "modul": [14, 15, 17], "modular": 17, "more": [0, 2, 3, 4, 7, 8, 11, 12, 13, 15, 17], "moreov": 15, "move": 16, "movement": 14, "multi": 17, "multipl": [1, 12, 14, 15, 17], "name": 2, "natur": 15, "navig": [0, 1, 2, 3, 4, 7, 8, 12, 14, 15, 16], "necessari": [1, 12], "need": [1, 12, 13, 16, 17], "network": 17, "node": [15, 17], "node_nam": 17, "noetic": 1, "noisi": 15, "normal": [1, 12], "note": 13, "null": [12, 13], "o": [12, 13], "object": [14, 15], "observ": 15, "obstacl": 15, "odometri": 14, "offer": [15, 17], "offici": [11, 12, 13, 17], "onli": [1, 11, 12, 13], "open": [0, 11, 15], "oper": [15, 17], "opt": 13, "option": 0, "order": 16, "org": 13, "organ": 15, "origin": 3, "other": 17, "our": [1, 12, 13, 14, 15, 16], "outdoor": 2, "output": 15, "overview": [10, 16], "own": 13, "packag": [1, 12, 13], "package_nam": 17, "paper": 3, "paragraph": 14, "particularli": 17, "path": [0, 15], "perform": [15, 17], "pipelin": 15, "place": 15, "platform": 17, "pleas": [0, 2, 3, 4, 7, 8, 10, 11, 12, 13, 16, 17], "plugin": 12, "point": [14, 15], "possibl": 16, "power": 14, "prebuilt": 10, "predict": 17, "present": 15, "press": 11, "previous": 15, "primarili": 3, "print": [12, 13], "process": [4, 14, 15, 16], "project": [0, 4, 10], "properti": [12, 13], "propos": 15, "proven": 15, "provid": [11, 15, 16, 17], "pub": 17, "publish": 17, "pull": [0, 2, 3, 4, 7, 8], "purpos": 16, "py": [0, 2, 4, 8, 16], "queri": [1, 10, 14, 15], "question": 10, "quick": 10, "r": 12, "raw": 13, "read": [3, 16], "readabl": 15, "readm": [0, 2, 4, 7, 8], "real": [1, 10, 15, 16, 17], "realsens": [1, 10, 14], "realsense_ros1_w": 1, "reason": [15, 17], "receiv": 14, "refer": [0, 2, 3, 4, 7, 8], "region": 14, "reinforc": 15, "relationship": [14, 15], "releas": [12, 13], "reliabl": 17, "remot": 14, "replac": 2, "repositori": [0, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 16], "repres": [14, 15], "reproduct": 16, "requir": [12, 17], "research": [15, 17], "respons": [15, 17], "return": 14, "reus": 17, "reward": 15, "rgbd": [14, 15], "rl": 15, "rl_env": [4, 16], "rm": [3, 16], "ro": [10, 13, 15], "robot": [0, 1, 2, 10, 14, 15, 16, 17], "robust": 17, "ros1": [1, 10, 17], "ros1_bridg": 16, "ros1_bridge_w": [1, 7, 16], "ros2": [0, 1, 2, 4, 7, 8, 10, 16], "ros_hostnam": 16, "ros_master_uri": 16, "rosdep": 0, "rosdistro": [0, 13], "roslaunch": [3, 16], "rqt_robot_st": 0, "run": [0, 4, 10, 16], "rviz": 16, "same": 17, "scalabl": 17, "scale": 17, "scene": [1, 4, 10, 14, 15, 16], "screenshot": 16, "script": [4, 8], "section": 16, "see": [16, 17], "segment": [14, 15], "semant": [14, 15], "send": 14, "sensor": [14, 15], "serv": [14, 15], "server": [14, 15], "servic": 17, "session": 0, "set": [0, 4, 5, 6, 8, 10, 13, 15, 16, 17], "setup": [0, 1, 2, 3, 12, 13, 16], "sever": [2, 15, 17], "sg": 14, "sh": [4, 8], "share": 13, "shell": 13, "should": [15, 16], "sign": [12, 13], "signal": [14, 15], "significantli": 15, "sim": 10, "simpl": [10, 17], "simplifi": 16, "simul": [0, 4, 10, 16], "skip": 11, "slam": [0, 1, 8, 14], "sleep": 15, "softwar": [10, 12, 13, 17], "some": [16, 17], "sourc": [0, 2, 3, 12, 13, 16], "sparsiti": 15, "spatial": 14, "specif": [15, 17], "specifi": [1, 15], "split": 12, "src": 0, "ssl": 13, "stabl": 12, "standard": 17, "start": [10, 17], "step": [4, 11, 12, 13, 16], "structur": [15, 17], "studi": 15, "studio": 11, "sudo": [12, 13], "suggest": 15, "suit": 17, "suitabl": 17, "support": [15, 17], "sure": [4, 16], "symlink": [2, 4], "sync": 17, "system": [12, 13, 15, 17], "target": 10, "task": [14, 15, 17], "team": 17, "tee": [12, 13], "teleop": 4, "teleop_twist_keyboard": 16, "teleoper": 16, "test": [2, 10, 17], "thei": 17, "them": [14, 17], "thi": [0, 2, 3, 4, 5, 6, 7, 8, 11, 15, 16, 17], "those": 17, "through": 4, "time": [1, 15, 17], "tmux": 0, "togeth": [14, 17], "tool": 17, "topic": 17, "topic_nam": 17, "toward": 15, "tradit": 15, "train": 15, "transfer": 17, "transit": 15, "transport": 12, "travers": 15, "true": [4, 8], "turtlebot3": 10, "turtlebot3_gazebo": 0, "turtlebot3_model": 0, "turtlebot3_world": 0, "ubuntu": [12, 13], "ubuntu_codenam": 13, "uhumans2": [3, 16], "understand": [14, 15, 16], "univers": 13, "unlik": 17, "unseen": 15, "unstabl": 15, "up": [0, 1, 2, 4, 5, 6, 7, 8, 12, 13, 16, 17], "updat": [0, 12, 13, 15], "upgrad": 13, "us": [0, 1, 10, 11, 12, 14, 15, 16], "user": 15, "usr": 13, "util": [7, 14], "valuabl": [2, 15], "variabl": 13, "variat": 16, "variou": [14, 15, 17], "vehicl": 17, "velodyne_descript": 8, "verifi": 12, "versatil": 17, "version": [12, 13], "version_codenam": 12, "view": 17, "visit": [11, 12, 13, 17], "visual": 11, "vlp": [1, 10], "vlp16": 14, "vlp_cartograph": 8, "vlp_driver": 8, "vlp_w": [1, 8], "volum": 17, "vscode": 11, "w": [0, 2, 3, 4, 8, 16], "want": [11, 13, 14, 15, 16], "we": [0, 1, 12, 13, 14, 15, 16], "websit": [11, 12, 13, 17], "well": 17, "what": 10, "wheel": 14, "when": 13, "where": [15, 17], "whether": 17, "which": [2, 14, 15, 17], "why": 10, "window": 17, "wish": 2, "within": [0, 13, 15], "work": [14, 17], "workspac": [1, 10, 12], "world": [1, 4, 8, 10, 15], "y": [0, 13], "yaml": 14, "you": [1, 2, 4, 10, 11, 12, 13, 16, 17], "your": [12, 13, 16], "yourself": 13, "yuzhong": [0, 2, 3, 4, 7, 8, 16], "yuzhong1214": 10, "zmq_ip": 16}, "titles": ["2. Cartographer Workspace", "1. CodeBase Overview", "3. Gazebo World Workspace", "4. Hydra Workspace", "5. Kobuki Workspace", "6. LLM Query Workspace", "7. Realsense Workspace", "8. ROS1 Bridge Workspace", "9. VLP-16 LiDAR Workspace", "1. Demo", "LLM-Navigation documentation", "2. Devcontainer", "1. Docker", "3. ROS2 Humble", "2. Architecture", "1. Introduction", "4. Quick start", "3. ROS2"], "titleterms": {"16": 8, "architectur": 14, "basic": 17, "bridg": 7, "build": [0, 2, 3, 4, 8], "cartograph": 0, "cli": 17, "codebas": [1, 10], "command": 17, "core": 17, "default": 3, "demo": [9, 10], "devcontain": 11, "docker": [0, 2, 3, 4, 8, 12], "document": 10, "environ": 8, "featur": [15, 17], "gazebo": [2, 4, 9], "habitat": 9, "hardwar": 14, "humbl": 13, "hydra": 3, "i": 17, "imag": [0, 2, 3, 4, 7, 8], "instal": 10, "introduct": [10, 15], "kobuki": 4, "lidar": 8, "link": 10, "llm": [5, 10], "navig": 10, "overview": 1, "prebuilt": 7, "queri": 5, "quick": [4, 16], "real": [4, 8], "realsens": 6, "ro": 17, "robot": [4, 8], "ros1": 7, "ros2": [13, 17], "run": [2, 3, 7], "set": 3, "sim": 9, "simpl": [0, 4], "simul": 8, "softwar": 14, "start": [4, 16], "target": 2, "test": [0, 4, 8], "turtlebot3": 2, "us": 17, "vlp": 8, "what": 17, "why": 17, "workspac": [0, 2, 3, 4, 5, 6, 7, 8], "world": 2}}) \ No newline at end of file