From d6a2002505dfd93a25cefbbfe3257e9faf0b6df8 Mon Sep 17 00:00:00 2001 From: Lorenz Meier Date: Sun, 7 Jan 2018 20:22:16 +0100 Subject: [PATCH] Sensors: Update param metadata This hides these parameters by default from the user. --- src/modules/sensors/sensor_params_acc0.c | 10 +++++++++- src/modules/sensors/sensor_params_acc1.c | 8 ++++++++ src/modules/sensors/sensor_params_acc2.c | 8 ++++++++ src/modules/sensors/sensor_params_accel.c | 1 + 4 files changed, 26 insertions(+), 1 deletion(-) diff --git a/src/modules/sensors/sensor_params_acc0.c b/src/modules/sensors/sensor_params_acc0.c index 1b0bdd130a..fe8ba73bc1 100644 --- a/src/modules/sensors/sensor_params_acc0.c +++ b/src/modules/sensors/sensor_params_acc0.c @@ -1,6 +1,6 @@ /**************************************************************************** * - * Copyright (c) 2012-2017 PX4 Development Team. All rights reserved. + * Copyright (c) 2012-2018 PX4 Development Team. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -34,6 +34,7 @@ /** * ID of the Accelerometer that the calibration is for. * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC0_ID, 0); @@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC0_ID, 0); * Accelerometer 0 enabled * * @boolean + * @category developer * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC0_EN, 1); @@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC0_EN, 1); /** * Accelerometer X-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_XOFF, 0.0f); @@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_XOFF, 0.0f); /** * Accelerometer Y-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_YOFF, 0.0f); @@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_YOFF, 0.0f); /** * Accelerometer Z-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_ZOFF, 0.0f); @@ -70,6 +75,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_ZOFF, 0.0f); /** * Accelerometer X-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_XSCALE, 1.0f); @@ -77,6 +83,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_XSCALE, 1.0f); /** * Accelerometer Y-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_YSCALE, 1.0f); @@ -84,6 +91,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_YSCALE, 1.0f); /** * Accelerometer Z-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC0_ZSCALE, 1.0f); diff --git a/src/modules/sensors/sensor_params_acc1.c b/src/modules/sensors/sensor_params_acc1.c index faf82ebf9e..e727ae2900 100644 --- a/src/modules/sensors/sensor_params_acc1.c +++ b/src/modules/sensors/sensor_params_acc1.c @@ -34,6 +34,7 @@ /** * ID of the Accelerometer that the calibration is for. * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC1_ID, 0); @@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC1_ID, 0); * Accelerometer 1 enabled * * @boolean + * @category developer * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC1_EN, 1); @@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC1_EN, 1); /** * Accelerometer X-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_XOFF, 0.0f); @@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_XOFF, 0.0f); /** * Accelerometer Y-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_YOFF, 0.0f); @@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_YOFF, 0.0f); /** * Accelerometer Z-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_ZOFF, 0.0f); @@ -70,6 +75,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_ZOFF, 0.0f); /** * Accelerometer X-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_XSCALE, 1.0f); @@ -77,6 +83,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_XSCALE, 1.0f); /** * Accelerometer Y-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_YSCALE, 1.0f); @@ -84,6 +91,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_YSCALE, 1.0f); /** * Accelerometer Z-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC1_ZSCALE, 1.0f); diff --git a/src/modules/sensors/sensor_params_acc2.c b/src/modules/sensors/sensor_params_acc2.c index 6ca19227b8..39dc2b0098 100644 --- a/src/modules/sensors/sensor_params_acc2.c +++ b/src/modules/sensors/sensor_params_acc2.c @@ -34,6 +34,7 @@ /** * ID of the Accelerometer that the calibration is for. * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC2_ID, 0); @@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC2_ID, 0); * Accelerometer 2 enabled * * @boolean + * @category developer * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC2_EN, 1); @@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC2_EN, 1); /** * Accelerometer X-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_XOFF, 0.0f); @@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_XOFF, 0.0f); /** * Accelerometer Y-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_YOFF, 0.0f); @@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_YOFF, 0.0f); /** * Accelerometer Z-axis offset * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_ZOFF, 0.0f); @@ -70,6 +75,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_ZOFF, 0.0f); /** * Accelerometer X-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_XSCALE, 1.0f); @@ -77,6 +83,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_XSCALE, 1.0f); /** * Accelerometer Y-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_YSCALE, 1.0f); @@ -84,6 +91,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_YSCALE, 1.0f); /** * Accelerometer Z-axis scaling factor * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(CAL_ACC2_ZSCALE, 1.0f); diff --git a/src/modules/sensors/sensor_params_accel.c b/src/modules/sensors/sensor_params_accel.c index 09b4c92cd9..7930422548 100644 --- a/src/modules/sensors/sensor_params_accel.c +++ b/src/modules/sensors/sensor_params_accel.c @@ -34,6 +34,7 @@ /** * Primary accel ID * + * @category system * @group Sensor Calibration */ PARAM_DEFINE_INT32(CAL_ACC_PRIME, 0);