Sensors: Update param metadata

This hides these parameters by default from the user.
This commit is contained in:
Lorenz Meier
2018-01-08 09:27:22 +01:00
parent b07deed6c6
commit d6a2002505
4 changed files with 26 additions and 1 deletions
+9 -1
View File
@@ -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 * Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions * modification, are permitted provided that the following conditions
@@ -34,6 +34,7 @@
/** /**
* ID of the Accelerometer that the calibration is for. * ID of the Accelerometer that the calibration is for.
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC0_ID, 0); PARAM_DEFINE_INT32(CAL_ACC0_ID, 0);
@@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC0_ID, 0);
* Accelerometer 0 enabled * Accelerometer 0 enabled
* *
* @boolean * @boolean
* @category developer
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC0_EN, 1); PARAM_DEFINE_INT32(CAL_ACC0_EN, 1);
@@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC0_EN, 1);
/** /**
* Accelerometer X-axis offset * Accelerometer X-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_XOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC0_XOFF, 0.0f);
@@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_XOFF, 0.0f);
/** /**
* Accelerometer Y-axis offset * Accelerometer Y-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_YOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC0_YOFF, 0.0f);
@@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC0_YOFF, 0.0f);
/** /**
* Accelerometer Z-axis offset * Accelerometer Z-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_ZOFF, 0.0f); 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 * Accelerometer X-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_XSCALE, 1.0f); 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 * Accelerometer Y-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_YSCALE, 1.0f); 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 * Accelerometer Z-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC0_ZSCALE, 1.0f); PARAM_DEFINE_FLOAT(CAL_ACC0_ZSCALE, 1.0f);
+8
View File
@@ -34,6 +34,7 @@
/** /**
* ID of the Accelerometer that the calibration is for. * ID of the Accelerometer that the calibration is for.
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC1_ID, 0); PARAM_DEFINE_INT32(CAL_ACC1_ID, 0);
@@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC1_ID, 0);
* Accelerometer 1 enabled * Accelerometer 1 enabled
* *
* @boolean * @boolean
* @category developer
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC1_EN, 1); PARAM_DEFINE_INT32(CAL_ACC1_EN, 1);
@@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC1_EN, 1);
/** /**
* Accelerometer X-axis offset * Accelerometer X-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_XOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC1_XOFF, 0.0f);
@@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_XOFF, 0.0f);
/** /**
* Accelerometer Y-axis offset * Accelerometer Y-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_YOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC1_YOFF, 0.0f);
@@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC1_YOFF, 0.0f);
/** /**
* Accelerometer Z-axis offset * Accelerometer Z-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_ZOFF, 0.0f); 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 * Accelerometer X-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_XSCALE, 1.0f); 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 * Accelerometer Y-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_YSCALE, 1.0f); 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 * Accelerometer Z-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC1_ZSCALE, 1.0f); PARAM_DEFINE_FLOAT(CAL_ACC1_ZSCALE, 1.0f);
+8
View File
@@ -34,6 +34,7 @@
/** /**
* ID of the Accelerometer that the calibration is for. * ID of the Accelerometer that the calibration is for.
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC2_ID, 0); PARAM_DEFINE_INT32(CAL_ACC2_ID, 0);
@@ -42,6 +43,7 @@ PARAM_DEFINE_INT32(CAL_ACC2_ID, 0);
* Accelerometer 2 enabled * Accelerometer 2 enabled
* *
* @boolean * @boolean
* @category developer
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC2_EN, 1); PARAM_DEFINE_INT32(CAL_ACC2_EN, 1);
@@ -49,6 +51,7 @@ PARAM_DEFINE_INT32(CAL_ACC2_EN, 1);
/** /**
* Accelerometer X-axis offset * Accelerometer X-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_XOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC2_XOFF, 0.0f);
@@ -56,6 +59,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_XOFF, 0.0f);
/** /**
* Accelerometer Y-axis offset * Accelerometer Y-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_YOFF, 0.0f); PARAM_DEFINE_FLOAT(CAL_ACC2_YOFF, 0.0f);
@@ -63,6 +67,7 @@ PARAM_DEFINE_FLOAT(CAL_ACC2_YOFF, 0.0f);
/** /**
* Accelerometer Z-axis offset * Accelerometer Z-axis offset
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_ZOFF, 0.0f); 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 * Accelerometer X-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_XSCALE, 1.0f); 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 * Accelerometer Y-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_YSCALE, 1.0f); 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 * Accelerometer Z-axis scaling factor
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_FLOAT(CAL_ACC2_ZSCALE, 1.0f); PARAM_DEFINE_FLOAT(CAL_ACC2_ZSCALE, 1.0f);
@@ -34,6 +34,7 @@
/** /**
* Primary accel ID * Primary accel ID
* *
* @category system
* @group Sensor Calibration * @group Sensor Calibration
*/ */
PARAM_DEFINE_INT32(CAL_ACC_PRIME, 0); PARAM_DEFINE_INT32(CAL_ACC_PRIME, 0);