Skip to content
This repository was archived by the owner on Oct 8, 2025. It is now read-only.

Commit 1d92ed8

Browse files
committed
Readme update with Maps Manager instructions
1 parent ec9c9e4 commit 1d92ed8

1 file changed

Lines changed: 64 additions & 5 deletions

File tree

README.md

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
This stack is part of the Easy Navigation (EasyNav) project developed by the Intelligent Robotics Lab. It is composed of the **pointcloud_maps_builder** package and the **pointcloud_maps_manager** package (currently under construction).
44

5-
The `PointcloudMapsBuilderNode` subscribes to point cloud sensor data, downsamples and fuses it, and republishes the processed data for mapping or further processing.
6-
5+
## Pointcloud Maps Builder
76

7+
The `PointcloudMapsBuilderNode` subscribes to point cloud sensor data, downsamples and fuses it, and republishes the processed data for mapping or further processing.
88

9-
## Parameters
9+
### Parameters
1010

1111
| Parameter Name | Type | Default | Description |
1212
|--------------------------|---------|-----------|--------------------------------------------------|
@@ -16,7 +16,7 @@ The `PointcloudMapsBuilderNode` subscribes to point cloud sensor data, downsampl
1616

1717
---
1818

19-
## Installation
19+
### Installation
2020

2121
Clone the repository into your ROS 2 workspace:
2222
```bash
@@ -26,7 +26,7 @@ cd ..
2626
colcon build --packages-select easynav_pointcloud_maps_builder
2727
```
2828

29-
## Usage
29+
### Usage
3030

3131
Source your workspace:
3232
```bash
@@ -57,4 +57,63 @@ pointcloud_maps_builder_node:
5757
```
5858
ros2 run easynav_pointcloud_maps_builder pointcloud_maps_builder_main \
5959
--ros-args --params-file src/easynav_pointcloud_stack/params.yaml
60+
```
61+
62+
## Pointcloud Maps Manager
63+
64+
The `PointcloudMapsManager` subscribes to point cloud topic managed by Maps Builder. There is another option when the point cloud is stored in a Point Cloud Data file (`.pcd`). The manager can handle both cases, allowing for flexible integration with existing point cloud data.
65+
66+
### Parameters
67+
68+
| Parameter Name | Type | Default | Description |
69+
|--------------------------|---------|-----------|--------------------------------------------------|
70+
| `map_types` | string | ` ` | Map representation defined by map manager |
71+
72+
By each `map_types` define in the params file is required to define the following parameters:
73+
74+
| Parameter Name | Type | Default | Description |
75+
|--------------------------|---------|-----------|--------------------------------------------------|
76+
| `map_topic_in` | string | `/<node name>/<plugin name>/topic_in` | Topic where the point cloud is received |
77+
| `package_name` | string | ` ` | Package name where is located the `pcd` file.|
78+
| `map_path_file` | string | `pointcloud_map.pcd` | Filename for `pcd` map file. |
79+
80+
>> note: The `map_path_file` is only required if the `package_name` is defined. If not, the point cloud data will be read from topic defined in `map_topic_in`.
81+
82+
### Installation
83+
84+
Clone the repository into your ROS 2 workspace:
85+
```bash
86+
cd ~/ros2_ws/src
87+
git clone https://github.com/EasyNavigation/easynav_pointcloud_stack.git
88+
cd ..
89+
colcon build --packages-select easynav_pointcloud_maps_manager easynav_pointcloud_common
90+
```
91+
92+
### Usage
93+
94+
Source your workspace:
95+
```bash
96+
source ~/ros2_ws/install/setup.bash
97+
```
98+
Run the lifecycle node:
99+
```bash
100+
ros2 run easynav_system system_main --ros-args --params-file <ros workspace path>/src/easynav_pointcloud_stack/robot_params/maps_manager.params.yaml
101+
```
102+
103+
The file `maps_manager.params.yaml` could be modified to include the desired point cloud map types and their respective parameters.
104+
105+
## How to create a parameter file for Pointcloud Maps Manager
106+
107+
1. Create a parameter YAML file (e.g., `params.yaml`) with the following content:
108+
109+
```yaml
110+
maps_manager_node:
111+
ros__parameters:
112+
use_sim_time: true # When data source is from file this parameter should be set to false
113+
map_types: [PointCloudData] # Map types defined by the manager
114+
PointCloudData:
115+
plugin: easynav_pointcloud_maps_manager/PointCloudMapsManager # Plugin name
116+
map_topic_in: /map_builder/cloud_filtered # Topic where the point cloud is received
117+
package_name: easynav_outdoor_testcase # Package name where is located the `pcd` file.
118+
map_path_file: maps/pointcloud_map.pcd # Filename for `pcd` map file.
60119
```

0 commit comments

Comments
 (0)