src/main/flight/wind_estimator.h

   1 /*
   2  * This file is part of Cleanflight.
   3  *
   4  * Cleanflight is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * Cleanflight is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with Cleanflight.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #pragma once
  19
  20 #if defined(USE_WIND_ESTIMATOR)
  21 #if !defined(USE_GPS)
  22 #error Wind Estimator requires GPS support
  23 #endif
  24
  25 #include "common/axis.h"
  26 #include "common/time.h"
  27
  28 bool isEstimatedWindSpeedValid(void);
  29 // wind velocity vectors in cm / sec relative to the earth frame
  30 float getEstimatedWindSpeed(int axis);
  31 // Returns the horizontal wind velocity as a magnitude in cm/s and,
  32 // optionally, its heading in EF in 0.01deg ([0, 360*100)).
  33 float getEstimatedHorizontalWindSpeed(uint16_t *angle);
  34
  35 void updateWindEstimator(timeUs_t currentTimeUs);
  36
  37 #endif