Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-06-01 02:55:07 +08:00
Code Issues Actions 20 Packages Projects Releases Wiki Activity

Add module docs for leddar_one

Browse Source
This commit is contained in:
Hamish Willee
2019-02-12 16:26:07 -08:00
committed by Beat Küng
parent 57f1f01319
commit f8c0849ff7
1 changed files with 32 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/drivers/distance_sensor/leddar_one/leddar_one.cpp
+32 -4
View File
@@ -35,6 +35,7 @@
#include <px4_workqueue.h> #include <px4_workqueue.h>
#include <px4_getopt.h> #include <px4_getopt.h>
#include <px4_defines.h> #include <px4_defines.h>
#include <px4_module.h>
#include <stdlib.h> #include <stdlib.h>
#include <string.h> #include <string.h>
@@ -157,10 +158,33 @@ extern "C" __EXPORT int leddar_one_main(int argc, char *argv[]);
static void help() static void help()
{ {
printf("missing command: try 'start', 'stop' or 'test'\n"); PRINT_MODULE_DESCRIPTION(
printf("options:\n"); R"DESCR_STR(
printf(" -d <serial port> to set the serial port were " NAME " is connected\n"); ### Description
printf(" -r rotation\n");
Serial bus driver for the LeddarOne LiDAR.
Most boards are configured to enable/start the driver on a specified UART using the SENS_LEDDAR1_CFG parameter.
Setup/usage information: https://docs.px4.io/en/sensor/leddar_one.html
### Examples
Attempt to start driver on a specified serial device.
$ leddar_one start -d /dev/ttyS1
Stop driver
$ leddar_one stop
)DESCR_STR");
PRINT_MODULE_USAGE_NAME("leddar_one", "driver");
PRINT_MODULE_USAGE_SUBCATEGORY("distance_sensor");
PRINT_MODULE_USAGE_COMMAND_DESCR("start","Start driver");
PRINT_MODULE_USAGE_PARAM_STRING('d', nullptr, nullptr, "Serial device", false);
PRINT_MODULE_USAGE_PARAM_INT('r', 25, 1, 25, "Sensor rotation - downward facing by default", true);
PRINT_MODULE_USAGE_COMMAND_DESCR("stop","Stop driver");
PRINT_MODULE_USAGE_COMMAND_DESCR("test","Test driver (basic functional tests)");
PRINT_MODULE_USAGE_COMMAND_DESCR("info","Print driver information");
} }
int leddar_one_main(int argc, char *argv[]) int leddar_one_main(int argc, char *argv[])
@@ -183,6 +207,7 @@ int leddar_one_main(int argc, char *argv[])
break; break;
default: default:
PX4_WARN("Unknown option!");
help(); help();
return PX4_ERROR; return PX4_ERROR;
} }
@@ -234,8 +259,11 @@ int leddar_one_main(int argc, char *argv[])
print_message(report); print_message(report);
} else if (!strcmp(verb, "info")) {
help();
} else { } else {
help(); help();
PX4_ERR("unrecognized command");
return PX4_ERROR; return PX4_ERROR;
} }