PX4 Firmware
PX4 Autopilot Software http://px4.io
params.c
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2012-2016 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
34 /**
35  * UTC offset (unit: min)
36  *
37  * the difference in hours and minutes from Coordinated
38  * Universal Time (UTC) for a your place and date.
39  *
40  * for example, In case of South Korea(UTC+09:00),
41  * UTC offset is 540 min (9*60)
42  *
43  * refer to https://en.wikipedia.org/wiki/List_of_UTC_time_offsets
44  *
45  * @unit min
46  * @min -1000
47  * @max 1000
48  * @group SD Logging
49  */
50 PARAM_DEFINE_INT32(SDLOG_UTC_OFFSET, 0);
51 
52 /**
53  * Logging Mode
54  *
55  * Determines when to start and stop logging. By default, logging is started
56  * when arming the system, and stopped when disarming.
57  *
58  * @value -1 disabled
59  * @value 0 when armed until disarm (default)
60  * @value 1 from boot until disarm
61  * @value 2 from boot until shutdown
62  * @value 3 depending on AUX1 RC channel
63  *
64  * @reboot_required true
65  * @group SD Logging
66  */
67 PARAM_DEFINE_INT32(SDLOG_MODE, 0);
68 
69 /**
70  * Mission Log
71  *
72  * If enabled, a small additional "mission" log file will be written to the SD card.
73  * The log contains just those messages that are useful for tasks like
74  * generating flight statistics and geotagging.
75  *
76  * The different modes can be used to further reduce the logged data
77  * (and thus the log file size). For example, choose geotagging mode to
78  * only log data required for geotagging.
79 
80  * Note that the normal/full log is still created, and contains all
81  * the data in the mission log (and more).
82  *
83  * @value 0 Disabled
84  * @value 1 All mission messages
85  * @value 2 Geotagging messages
86  *
87  * @reboot_required true
88  * @group SD Logging
89  */
90 PARAM_DEFINE_INT32(SDLOG_MISSION, 0);
91 
92 /**
93  * Logging topic profile (integer bitmask).
94  *
95  * This integer bitmask controls the set and rates of logged topics.
96  * The default allows for general log analysis and estimator replay, while
97  * keeping the log file size reasonably small.
98  *
99  * Enabling multiple sets leads to higher bandwidth requirements and larger log
100  * files.
101  *
102  * Set bits true to enable:
103  * 0 : Default set (used for general log analysis)
104  * 1 : Full rate estimator (EKF2) replay topics
105  * 2 : Topics for thermal calibration (high rate raw IMU and Baro sensor data)
106  * 3 : Topics for system identification (high rate actuator control and IMU data)
107  * 4 : Full rates for analysis of fast maneuvers (RC, attitude, rates and actuators)
108  * 5 : Debugging topics (debug_*.msg topics, for custom code)
109  * 6 : Topics for sensor comparison (low rate raw IMU, Baro and Magnetomer data)
110  * 7 : Topics for computer vision and collision avoidance
111  *
112  * @min 0
113  * @max 255
114  * @bit 0 Default set (general log analysis)
115  * @bit 1 Estimator replay (EKF2)
116  * @bit 2 Thermal calibration
117  * @bit 3 System identification
118  * @bit 4 High rate
119  * @bit 5 Debug
120  * @bit 6 Sensor comparison
121  * @bit 7 Computer Vision and Avoidance
122  * @reboot_required true
123  * @group SD Logging
124  */
125 PARAM_DEFINE_INT32(SDLOG_PROFILE, 3);
126 
127 /**
128  * Maximum number of log directories to keep
129  *
130  * If there are more log directories than this value,
131  * the system will delete the oldest directories during startup.
132  *
133  * In addition, the system will delete old logs if there is not enough free space left.
134  * The minimum amount is 300 MB.
135  *
136  * If this is set to 0, old directories will only be removed if the free space falls below
137  * the minimum.
138  *
139  * Note: this does not apply to mission log files.
140  *
141  * @min 0
142  * @max 1000
143  * @reboot_required true
144  * @group SD Logging
145  */
146 PARAM_DEFINE_INT32(SDLOG_DIRS_MAX, 0);
147 
148 /**
149  * Log UUID
150  *
151  * If set to 1, add an ID to the log, which uniquely identifies the vehicle
152  *
153  * @boolean
154  * @group SD Logging
155  */
156 PARAM_DEFINE_INT32(SDLOG_UUID, 1);
PARAM_DEFINE_INT32(GPS_DUMP_COMM, 0)
Dump GPS communication to a file.