flight/libraries/inc/auxmagsupport.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       auxmagsupport.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2014.
   6  * @brief      Functions to handle aux mag data and calibration.
   7  *             --
   8  * @see        The GNU Public License (GPL) Version 3
   9  *
  10  *****************************************************************************/
  11 /*
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  20  * for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License along
  23  * with this program; if not, write to the Free Software Foundation, Inc.,
  24  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  25  */
  26 #ifndef AUXMAGSUPPORT_H_
  27 #define AUXMAGSUPPORT_H_
  28 #include <openpilot.h>
  29 #include <auxmagsettings.h>
  30 #include <auxmagsensor.h>
  31 /**
  32  * @brief reload Aux Mag settings
  33  */
  34 void auxmagsupport_reload_settings();
  35
  36 /**
  37  * @brief Publish a new Aux Magnetometer sample
  38  * @param[in] mags  Mag sample in milliGauss
  39  * @param[in] status one of AuxMagSensorStatusOptions option
  40  */
  41 void auxmagsupport_publish_samples(float mags[3], uint8_t status);
  42
  43 /**
  44  * @brief Get the Aux Mag settings Type option
  45  * @param[in] mags  Mag sample in milliGauss
  46  * @return one of AuxMagSettingsTypeOptions option
  47  */
  48 AuxMagSettingsTypeOptions auxmagsupport_get_type();
  49
  50
  51 #endif /* AUXMAGSUPPORT_H_ */