PX4 Firmware
PX4 Autopilot Software http://px4.io
FlightTaskAutoMapper2.hpp
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2018 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  * @file FlightTaskAutoMapper2.hpp
36  *
37  * Abstract Flight task which generates local setpoints
38  * based on the triplet type.
39  */
40 
41 #pragma once
42 
43 #include "FlightTaskAuto.hpp"
44 
46 {
47 public:
48  FlightTaskAutoMapper2() = default;
49  virtual ~FlightTaskAutoMapper2() = default;
50  bool activate(vehicle_local_position_setpoint_s last_setpoint) override;
51  bool update() override;
52 
53 protected:
54 
55  virtual void _generateSetpoints() = 0; /**< Generate velocity and position setpoint for following line. */
56 
57  void _prepareIdleSetpoints();
58  void _prepareLandSetpoints();
62 
63  void _updateAltitudeAboveGround(); /**< Computes altitude above ground based on sensors available. */
64  void updateParams() override; /**< See ModuleParam class */
65 
66  float _alt_above_ground{0.0f}; /**< If home provided, then it is altitude above home, otherwise it is altitude above local position reference. */
67 
69  (ParamFloat<px4::params::MPC_LAND_SPEED>) _param_mpc_land_speed,
70  (ParamFloat<px4::params::MPC_TILTMAX_LND>) _param_mpc_tiltmax_lnd,
71  (ParamInt<px4::params::MPC_LAND_RC_HELP>) _param_mpc_land_rc_help,
72  (ParamFloat<px4::params::MPC_LAND_ALT1>)
73  _param_mpc_land_alt1, // altitude at which speed limit downwards reaches maximum speed
74  (ParamFloat<px4::params::MPC_LAND_ALT2>)
75  _param_mpc_land_alt2, // altitude at which speed limit downwards reached minimum speed
76  (ParamFloat<px4::params::MPC_TKO_SPEED>) _param_mpc_tko_speed
77  );
78 
79 private:
80 
81  void _reset(); /**< Resets member variables to current vehicle state */
82  WaypointType _type_previous{WaypointType::idle}; /**< Previous type of current target triplet. */
83  bool _highEnoughForLandingGear(); /**< Checks if gears can be lowered. */
84  float _getLandSpeed(); /**< Returns landing descent speed. */
85 };
Map from global triplet to local quadruple.
DEFINE_PARAMETERS_CUSTOM_PARENT(FlightTaskAuto,(ParamFloat< px4::params::MPC_LAND_SPEED >) _param_mpc_land_speed,(ParamFloat< px4::params::MPC_TILTMAX_LND >) _param_mpc_tiltmax_lnd,(ParamInt< px4::params::MPC_LAND_RC_HELP >) _param_mpc_land_rc_help,(ParamFloat< px4::params::MPC_LAND_ALT1 >) _param_mpc_land_alt1,(ParamFloat< px4::params::MPC_LAND_ALT2 >) _param_mpc_land_alt2,(ParamFloat< px4::params::MPC_TKO_SPEED >) _param_mpc_tko_speed)
float _getLandSpeed()
Returns landing descent speed.
FlightTaskAutoMapper2()=default
WaypointType
This enum has to agree with position_setpoint_s type definition The only reason for not using the str...
void _reset()
Resets member variables to current vehicle state.
WaypointType _type_previous
Previous type of current target triplet.
bool update() override
To be called regularly in the control loop cycle to execute the task.
void updateParams() override
See ModuleParam class.
virtual ~FlightTaskAutoMapper2()=default
bool activate(vehicle_local_position_setpoint_s last_setpoint) override
Call once on the event where you switch to the task.
bool _highEnoughForLandingGear()
Checks if gears can be lowered.
float _alt_above_ground
If home provided, then it is altitude above home, otherwise it is altitude above local position refer...
void _updateAltitudeAboveGround()
Computes altitude above ground based on sensors available.
virtual void _generateSetpoints()=0
Generate velocity and position setpoint for following line.