Skip to content

Commit 6cd7214

Browse files
committed
Update docs
1 parent ec49583 commit 6cd7214

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

nav2_docking/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,12 @@ dock1:
9393
type: "dockv3"
9494
frame: map
9595
pose: [0.3, 0.3, 0.0]
96+
id: "kitchen_dock"
9697
dock2:
9798
type: "dockv1"
9899
frame: map
99100
pose: [0.0, 0.0, 0.4]
101+
id: "42"
100102
```
101103

102104
If you'd prefer to specify the docks using an external file, you may use the `dock_database` parameter to specify the filepath to the yaml file. The file should be laid out like:
@@ -107,13 +109,15 @@ docks:
107109
type: "dockv3"
108110
frame: map
109111
pose: [0.3, 0.3, 0.0]
112+
id: "kitchen_dock"
110113
dock2:
111114
type: "dockv1"
112115
frame: map
113116
pose: [0.0, 0.0, 0.4]
117+
id: "42"
114118
```
115119

116-
Note that you may leave the `type` to an empty string **if** there is only one type of dock being used. The `frame` will also default to `map` if not otherwise specified. The `type` and `pose` fields are required. Note also that these can be in any frame, not just map (i.e. `odom`, `base_link`, etc) in both the database and action requests.
120+
Note that you may leave the `type` to an empty string **if** there is only one type of dock being used. The `frame` will also default to `map` if not otherwise specified. The `type` and `pose` fields are required. Note also that these can be in any frame, not just map (i.e. `odom`, `base_link`, etc) in both the database and action requests. You may also specify the `id` field, for example to select the associated AprilTag. If the dock plugin does not use it, you can leave it unspecified.
117121

118122
## Dock Plugin API
119123

0 commit comments

Comments
 (0)