-
Notifications
You must be signed in to change notification settings - Fork 183
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added range sensor costmap layer to documentation #50
Changes from 2 commits
065139d
9561449
b789942
2d49f7b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
.. range: | ||
|
||
Range Sensor Parameters | ||
====================== | ||
|
||
``<range layer>`` is the corresponding plugin name selected for this type. | ||
|
||
:``<range layer>``.enabled: | ||
|
||
==== ======= | ||
Type Default | ||
---- ------- | ||
bool True | ||
==== ======= | ||
|
||
Description | ||
Whether it is enabled. | ||
|
||
:``<range layer>``.topics: | ||
|
||
==== ======= | ||
Type Default | ||
---- ------- | ||
bool [""] | ||
==== ======= | ||
|
||
Description | ||
Range topics to subscribe to. | ||
|
||
:``<range layer>``.phi: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
double 1.2 | ||
====== ======= | ||
|
||
Description | ||
Phi value. | ||
|
||
:``<range layer>``.inflate_cone: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
int 1.0 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. int != 1.0 |
||
====== ======= | ||
|
||
Description | ||
Inflate the triangular area covered by the sensor (percentage). | ||
|
||
:``<range layer>``.no_readings_timeout: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
double 0.0 | ||
====== ======= | ||
|
||
Description | ||
If zero, this parameter has no effect. Otherwise if the layer does | ||
not receive sensor data for this amount of time, | ||
the layer will warn the user and the layer will be marked as not current. | ||
|
||
:``<range layer>``.clear_threshold: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
double 0.2 | ||
====== ======= | ||
|
||
Description | ||
Probability below which cells are marked as free. | ||
|
||
:``<range layer>``.mark_threshold: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
int 0.8 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. int != 0.8 |
||
====== ======= | ||
|
||
Description | ||
Probability above which cells are marked as occupied. | ||
|
||
:``<range layer>``.clear_on_max_reading: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
int False | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. int != bool |
||
====== ======= | ||
|
||
Description | ||
Whether to clear the sensor readings on max range. | ||
|
||
:``<range layer>``.input_sensor_type: | ||
|
||
====== ======= | ||
Type Default | ||
------ ------- | ||
int ALL | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Isn't this a string input? |
||
====== ======= | ||
|
||
Description | ||
Input sensor type is either ALL (automatic selection), VARIABLE (min range != max range), or FIXED (min range == max range). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vector of strings?