mixer: add documentation

This commit is contained in:
Beat Küng
2017-05-04 16:39:51 +02:00
parent b18a148129
commit 3a880a09d6

View File

@@ -38,6 +38,7 @@
*/
#include <px4_config.h>
#include <px4_module.h>
#include <px4_posix.h>
#include <string.h>
#include <stdlib.h>
@@ -47,7 +48,6 @@
#include <errno.h>
#include <ctype.h>
#include <systemlib/err.h>
#include <systemlib/mixer/mixer.h>
#include <uORB/topics/actuator_controls.h>
@@ -110,8 +110,21 @@ usage(const char *reason)
PX4_INFO("%s", reason);
}
PX4_INFO("usage:");
PX4_INFO(" mixer load <device> <filename>");
PRINT_MODULE_DESCRIPTION(
R"DESCR_STR(
### Description
Load or append mixer files to the ESC driver.
Note that the driver must support the used ioctl's, which is the case on NuttX, but for example not on the RPi.
)DESCR_STR");
PRINT_MODULE_USAGE_NAME("mixer", "command");
PRINT_MODULE_USAGE_COMMAND("load");
PRINT_MODULE_USAGE_ARG("<file:dev> <file>", "Output device (eg. /dev/pwm_output0) and mixer file", false);
PRINT_MODULE_USAGE_COMMAND("append");
PRINT_MODULE_USAGE_ARG("<file:dev> <file>", "Output device (eg. /dev/pwm_output0) and mixer file", false);
}
static int