Ros_Qt5_Gui_App/doc/configuration_en.md
chengyangkj a0224d7c62
Some checks are pending
ROS2:Foxy(20.04) / release (map[image:ubuntu:focal ros:foxy]) (push) Waiting to run
ROS2:galactic(20.04) / release (map[image:ubuntu:focal ros:galactic]) (push) Waiting to run
ROS2:Humble(22.04) / release (map[image:ubuntu:jammy ros:humble]) (push) Waiting to run
ROS1:Melodic(18.04) / release (map[image:ubuntu:bionic ros:melodic]) (push) Waiting to run
ROS1:Noetic(20.04) / release (map[image:ubuntu:focal ros:noetic]) (push) Waiting to run
update readme
2025-03-08 17:40:46 +08:00

1.7 KiB

Configuration Guide

Configuration File Location

The configuration file config.json will be automatically generated in the same directory as the executable when first running the software. Changes to the configuration require restarting the software to take effect.

Configuration Items

ROS Topic Configuration

{
  "topics": {
    "map": {
      "display_name": "Map",
      "topic": "/map",
      "enable": true
    },
    "laser": {
      "display_name": "LaserScan", 
      "topic": "/scan",
      "enable": true
    },
    "odom": {
      "display_name": "Odometry",
      "topic": "/odom", 
      "enable": true
    },
    "velocity": {
      "display_name": "Speed",
      "topic": "/cmd_vel",
      "enable": true
    },
    "initialpose": {
      "display_name": "Reloc",
      "topic": "/initialpose",
      "enable": true
    },
    "move_base_simple": {
      "display_name": "NavGoal",
      "topic": "/move_base_simple/goal",
      "enable": true
    },
    "battery": {
      "display_name": "Battery",
      "topic": "/battery",
      "enable": true
    }
  }
}

Robot Shape Configuration

{
  "robot_shape_config": {
    "shaped_points": [
      {
        "x": 0.5,
        "y": 0.5
      },
      {
        "x": 0.5,
        "y": -0.5
      },
      {
        "x": -0.5,
        "y": -0.5
      },
      {
        "x": -0.5,
        "y": 0.5
      }
    ],
    "is_ellipse": false,
    "color": "0x00000FF",
    "opacity": 0.5
  }
}

Camera Configuration

{
  "images": [
    {
      "location": "front",
      "topic": "/camera/rgb/image_raw",
      "enable": true
    },
    {
      "location": "front/depth",
      "topic": "/camera/depth/image_raw", 
      "enable": true
    }
  ]
}