app.h

Aller à la documentation de ce fichier.

/*******************************************************************************
  MPLAB Harmony Application Header File
 
  Company:
    Microchip Technology Inc.
 
  File Name:
    app.h
 
  Summary:
    This header file provides prototypes and definitions for the application.
 
  Description:
    This header file provides function prototypes and data type definitions for
    the application.  Some of these are required by the system (such as the
    "APP_Initialize" and "APP_Tasks" prototypes) and some of them are only used
    internally by the application (such as the "APP_STATES" definition).  Both
    are defined here for convenience.
*******************************************************************************/
 
//DOM-IGNORE-BEGIN
/*******************************************************************************
Copyright (c) 2013-2014 released Microchip Technology Inc.  All rights reserved.
 
Microchip licenses to you the right to use, modify, copy and distribute
Software only when embedded on a Microchip microcontroller or digital signal
controller that is integrated into your product or third party product
(pursuant to the sublicense terms in the accompanying license agreement).
 
You should refer to the license agreement accompanying this Software for
additional information regarding your rights and obligations.
 
SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF
MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL MICROCHIP OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER
CONTRACT, NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR
OTHER LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR
CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT OF
SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
 *******************************************************************************/
//DOM-IGNORE-END
 
#ifndef _APP_H
#define _APP_H
 
// *****************************************************************************
// Section : Fichiers inclus
// *****************************************************************************
 
#include <stdint.h>             // Types entiers standards
#include <stdbool.h>            // Type booléen
#include <stddef.h>             // Définitions de taille
#include <stdlib.h>             // Fonctions utilitaires générales
#include "system_config.h"      // Configuration système
#include "system_definitions.h" // Définitions système
#include "Mc32Debounce.h"       // Gestion anti-rebond pour boutons
 
// DOM-IGNORE-BEGIN
#ifdef __cplusplus              // Pour compatibilité C++
extern "C" {
#endif
// DOM-IGNORE-END
 
// *****************************************************************************
// Section : Définitions de types
// *****************************************************************************
 
// *****************************************************************************
// Enumération des états de l'application
// *****************************************************************************
typedef enum
{
  APP_STATE_INIT = 0,         // État initial de l'application
  APP_STATE_WAIT,             // Attente d'un événement
  APP_STATE_SERVICE_TASKS     // Exécution des tâches de service
} APP_STATES;
 
// *****************************************************************************
// Structure des données de l'application
// *****************************************************************************
#define LOWBAT_THRESHOLD 2400   // Seuil de batterie faible (2.4V)
 
typedef struct
{
  APP_STATES state;           // État courant de l'application
  bool isDoor;                // Indique si la porte est détectée
  uint16_t batVoltage;        // Tension de la batterie
  bool isLowBat;              // Indique si la batterie est faible
} APP_DATA;
 
// *****************************************************************************
// Déclarations externes des descripteurs de boutons
// *****************************************************************************
extern S_SwitchDescriptor swRing;   // Descripteur du bouton de sonnette
extern S_SwitchDescriptor swEnter;  // Descripteur du bouton d'entrée
extern S_SwitchDescriptor swWait;   // Descripteur du bouton d'attente
extern S_SwitchDescriptor swBusy;   // Descripteur du bouton d'occupation
 
// *****************************************************************************
// Section : Prototypes des fonctions de l'application
// *****************************************************************************
 
/*******************************************************************************
  Fonction : void APP_Initialize(void)
  Initialise l'application Harmony, place dans l'état initial.
*******************************************************************************/
void APP_Initialize(void);      // Initialise l'application
 
/*******************************************************************************
  Fonction : void APP_Tasks(void)
  Machine à états principale de l'application Harmony.
*******************************************************************************/
void APP_Tasks(void);           // Exécute les tâches de l'application
 
/*******************************************************************************
  Fonction : void APP_UpdateState(APP_STATES newState)
  Met à jour l'état de l'application.
*******************************************************************************/
void APP_UpdateState(APP_STATES newState); // Met à jour l'état
 
/*******************************************************************************
  Fonction : bool APP_GetIsDoor(void)
  Retourne l'état de détection de la porte.
*******************************************************************************/
bool APP_GetIsDoor(void);       // Retourne si la porte est détectée
 
// *****************************************************************************
// Fin des définitions externes et compatibilité C++
// *****************************************************************************
#ifdef __cplusplus
}
#endif
 
/*******************************************************************************
  Fin du fichier
*******************************************************************************/