flight/libraries/inc/alarms.h

   1 /**
   2  ******************************************************************************
   3  * @addtogroup OpenPilotSystem OpenPilot System
   4  * @{
   5  * @addtogroup OpenPilotLibraries OpenPilot System Libraries
   6  * @{
   7  * @file       alarms.h
   8  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   9  * @brief      Include file of the alarm library
  10  * @see        The GNU Public License (GPL) Version 3
  11  *
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28 #ifndef ALARMS_H
  29 #define ALARMS_H
  30
  31 #include <systemalarms.h>
  32 #define SYSTEMALARMS_ALARM_DEFAULT SYSTEMALARMS_ALARM_UNINITIALISED
  33
  34 int32_t AlarmsInitialize(void);
  35 int32_t AlarmsSet(SystemAlarmsAlarmElem alarm, SystemAlarmsAlarmOptions severity);
  36 int32_t ExtendedAlarmsSet(SystemAlarmsAlarmElem alarm,
  37                           SystemAlarmsAlarmOptions severity,
  38                           SystemAlarmsExtendedAlarmStatusOptions status,
  39                           uint8_t subStatus);
  40 SystemAlarmsAlarmOptions AlarmsGet(SystemAlarmsAlarmElem alarm);
  41 int32_t AlarmsDefault(SystemAlarmsAlarmElem alarm);
  42 void AlarmsDefaultAll();
  43 int32_t AlarmsClear(SystemAlarmsAlarmElem alarm);
  44 void AlarmsClearAll();
  45
  46 int32_t AlarmsHasWarnings();
  47 int32_t AlarmsHasErrors();
  48 int32_t AlarmsHasCritical();
  49 SystemAlarmsAlarmOptions AlarmsGetHighestSeverity();
  50
  51 #endif // ALARMS_H
  52
  53 /**
  54  * @}
  55  * @}
  56  */