/*
 * Copyright (C) 2015
 *
 * This file is part of paparazzi.
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * paparazzi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/**
 * @file firmwares/rotorcraft/guidance/guidance_module.h
 * Guidance in a module file.
 *
 * Implement a custom controller in a module.
 * Re-use desired modes:
 *
 * e.g.: <tt>#define GUIDANCE_V_MODE_MODULE_SETTING GUIDANCE_V_MODE_HOVER</tt>
 * can be used to only define a horizontal control in the module and use normal z_hold
 *
 * The guidance that the module implement must be activated with following defines:
 *
 * a) Implement own Horizontal loops when GUIDANCE_H_MODE_MODULE_SETTING is set to GUIDANCE_H_MODE_MODULE
 * One must then implement:
 * - void guidance_h_module_enter(void);
 * - void guidance_h_module_read_rc(void);
 * - void guidance_h_module_run(bool_t in_flight);
 *
 *
 * b) Implement own Vertical loops when GUIDANCE_V_MODE_MODULE_SETTING is set to GUIDANCE_V_MODE_MODULE
 * - void guidance_v_module_enter(void);
 * - void guidance_v_module_run(bool_t in_flight);
 *
 * If the module implements both V and H mode, take into account that the H is called first and later V
 *
 */

#ifndef GUIDANCE_MODULE_H_
#define GUIDANCE_MODULE_H_

#include "generated/modules.h"


#endif /* GUIDANCE_MODULE_H_ */
