flight/pios/inc/pios_hmc5843.h

   1 /**
   2  ******************************************************************************
   3  * @addtogroup PIOS PIOS Core hardware abstraction layer
   4  * @{
   5  * @addtogroup PIOS_HMC5843 HMC5843 Functions
   6  * @brief Deals with the hardware interface to the magnetometers
   7  * @{
   8  *
   9  * @file       pios_hmc5843.h
  10  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2012.
  11  * @brief      HMC5843 functions header.
  12  * @see        The GNU Public License (GPL) Version 3
  13  *
  14  *****************************************************************************/
  15 /*
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful, but
  22  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  23  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  24  * for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License along
  27  * with this program; if not, write to the Free Software Foundation, Inc.,
  28  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  29  */
  30
  31 #ifndef PIOS_HMC5843_H
  32 #define PIOS_HMC5843_H
  33
  34 /* Public Functions */
  35 extern void PIOS_HMC5843_Init(void);
  36 extern bool PIOS_HMC5843_NewDataAvailable(void);
  37 extern void PIOS_HMC5843_ReadMag(int16_t out[3]);
  38 extern void PIOS_HMC5843_ReadID(uint8_t out[4]);
  39
  40 #endif /* PIOS_HMC5843_H */
  41
  42 /**
  43  * @}
  44  * @}
  45  */