aboutsummaryrefslogtreecommitdiff
path: root/src/modules/fw_pos_control_l1/mtecs/mTecs.h
blob: 346acfaf38261a311111800bcf6969e2f1bba28f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/****************************************************************************
 *
 *   Copyright (c) 2013 PX4 Development Team. All rights reserved.
 *   Author: 	@author Thomas Gubler <thomasgubler@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/


/**
 * @file mTecs.h
 *
 * @author Thomas Gubler <thomasgubler@gmail.com>
 */


#ifndef MTECS_H_
#define MTECS_H_

#include "mTecs_blocks.h"

#include <controllib/block/BlockParam.hpp>
#include <drivers/drv_hrt.h>
#include <uORB/Publication.hpp>
#include <uORB/topics/tecs_status.h>

namespace fwPosctrl
{

/* Main class of the mTecs */
class mTecs : public control::SuperBlock
{
public:
	mTecs();
	virtual ~mTecs();

	/* A small class which provides helper fucntions to override control output limits which are usually set by
	 * parameters in special cases
	 */
	class LimitOverride
	{
	public:
		LimitOverride() :
			overrideThrottleMinEnabled(false),
			overrideThrottleMaxEnabled(false),
			overridePitchMinEnabled(false),
			overridePitchMaxEnabled(false)
		{};

		~LimitOverride() {};

		/*
		 * Override the limits of the outputlimiter instances given by the arguments with the limits saved in
		 * this class (if enabled)
		 * @return true if the limit was applied
		 */
		bool applyOverride(BlockOutputLimiter &outputLimiterThrottle,
				BlockOutputLimiter &outputLimiterPitch);

		/* Functions to enable or disable the override */
		void enableThrottleMinOverride(float value) { enable(&overrideThrottleMinEnabled,
				&overrideThrottleMin, value); }
		void disableThrottleMinOverride() { disable(&overrideThrottleMinEnabled); }
		void enableThrottleMaxOverride(float value) { enable(&overrideThrottleMaxEnabled,
				&overrideThrottleMax, value); }
		void disableThrottleMaxOverride() { disable(&overrideThrottleMaxEnabled); }
		void enablePitchMinOverride(float value) { enable(&overridePitchMinEnabled,
				&overridePitchMin, value); }
		void disablePitchMinOverride() { disable(&overridePitchMinEnabled); }
		void enablePitchMaxOverride(float value) { enable(&overridePitchMaxEnabled,
				&overridePitchMax, value); }
		void disablePitchMaxOverride() { disable(&overridePitchMaxEnabled); }

	protected:
		bool overrideThrottleMinEnabled;
		float overrideThrottleMin;
		bool overrideThrottleMaxEnabled;
		float overrideThrottleMax;
		bool overridePitchMinEnabled;
		float overridePitchMin; //in degrees (replaces param values)
		bool overridePitchMaxEnabled;
		float overridePitchMax; //in degrees (replaces param values)

		/* Enable a specific limit override */
		void enable(bool *flag, float *limit, float value) { *flag = true; *limit = value;
		};
		/* Disable a specific limit override */
		void disable(bool *flag) { *flag = false; };


	};

	/*
	 * Control in altitude setpoint and speed mode
	 */
	int updateAltitudeSpeed(float flightPathAngle, float altitude, float altitudeSp, float airspeed,
			float airspeedSp, tecs_mode mode, LimitOverride limitOverride);

	/*
	 * Control in flightPathAngle setpoint (flollow a slope etc.) and speed mode
	 */
	int updateFlightPathAngleSpeed(float flightPathAngle, float flightPathAngleSp, float airspeed,
			float airspeedSp, tecs_mode mode, LimitOverride limitOverride);

	/*
	 * Control in flightPathAngle setpoint (flollow a slope etc.) and acceleration mode (base case)
	 */
	int updateFlightPathAngleAcceleration(float flightPathAngle, float flightPathAngleSp, float airspeed,
			float accelerationLongitudinalSp, tecs_mode mode, LimitOverride limitOverride);

	/*
	 * Reset all integrators
	 */
	void resetIntegrators();

	/*
	 * Reset all derivative calculations
	 */
	void resetDerivatives(float airspeed);

	/* Accessors */
	bool getEnabled() {return _mTecsEnabled.get() > 0;}
	float getThrottleSetpoint() {return _throttleSp;}
	float getPitchSetpoint() {return _pitchSp;}

protected:
	/* parameters */
	control::BlockParamInt _mTecsEnabled;		/**< 1 if mTecs is enabled */
	control::BlockParamFloat _airspeedMin;		/**< minimal airspeed */

	/* Publications */
	uORB::Publication<tecs_status_s> _status;	/**< publish internal values for logging */

	/* control blocks */
	BlockFFPILimitedCustom _controlTotalEnergy;		/**< FFPI controller for total energy control: output is throttle */
	BlockFFPILimitedCustom _controlEnergyDistribution;	/**< FFPI controller for energy distribution control: output is pitch */
	BlockPDLimited	_controlAltitude;		/**< PD controller for altitude: output is the flight path angle setpoint */
	BlockPDLimited	_controlAirSpeed;			/**< PD controller for airspeed: output is acceleration setpoint */

	/* Other calculation Blocks */
	control::BlockDerivative _airspeedDerivative;

	/* Output setpoints */
	float _throttleSp;				/**< Throttle Setpoint from 0 to 1 */
	float _pitchSp;					/**< Pitch Setpoint from -pi to pi */

	/* Output Limits in special modes */
	BlockOutputLimiter _BlockOutputLimiterTakeoffThrottle;		/**< Throttle Limits during takeoff */
	BlockOutputLimiter _BlockOutputLimiterTakeoffPitch;      	/**< Pitch Limit during takeoff */
	BlockOutputLimiter _BlockOutputLimiterUnderspeedThrottle;	/**< Throttle Limits when underspeed is detected */
	BlockOutputLimiter _BlockOutputLimiterUnderspeedPitch;   	/**< Pitch Limit when underspeed is detected */
	BlockOutputLimiter _BlockOutputLimiterLandThrottle;		/**< Throttle Limits during landing (only in last phase)*/
	BlockOutputLimiter _BlockOutputLimiterLandPitch;		/**< Pitch Limit during landing */

	/* Time measurements */
	hrt_abstime timestampLastIteration;		/**< Saves the result of hrt_absolute_time() of the last iteration */

	bool _firstIterationAfterReset;			/**< True during the first iteration after a reset */
	bool _dtCalculated;				/**< True if dt has been calculated in this iteration */

	int _counter;
	bool _debug;					///< Set true to enable debug output


	static void	debug_print(const char *fmt, va_list args);
	void		debug(const char *fmt, ...);

	/*
	 * Measure and update the time step dt if this was not already done in the current iteration
	 */
	void updateTimeMeasurement();
};

} /* namespace fwPosctrl */

#endif /* MTECS_H_ */