projet_voilier/Src/Sail.h
Arnaud Vergnet 4e69b9b112 improve doc
2020-11-15 16:53:55 +01:00

53 lines
1.1 KiB
C

#ifndef SAIL_H
#define SAIL_H
/**
* @brief Configure le servo moteur et le codeur incrémental pour la manipulation de la voile
* @note
* @param None
* @retval None
*/
void Sail_conf(void);
/**
* @brief Démarre le servo moteur et le codeur incrémental pour la manipulation de la voile
* @note
* @param None
* @retval None
*/
void Sail_start(void);
/**
* @brief Active le mode urgence des voiles pour les détendre
* @note
* @param None
* @retval None
*/
void Sail_setEmergency(int state);
/**
* @brief Retourne l'état d'alarme de la voile
* @note
* @param None
* @retval 1 si l'alarme est active, 0 sinon
*/
int Sail_getEmergencyState(void);
/**
* @brief Retourne l'angle du servo moteur de la voile
* @note
* @param None
* @retval angle en degrès entre 0 (tendu) et 90 (détendu)
*/
int Sail_getSailAngle(void);
/**
* @brief Ajuste l'angle du servo moteur de la voile en fonction de l'angle du vent capté par la girouette
* @note
* @param None
* @retval None
*/
void Sail_background(void);
#endif