From 2b236173afb8b644023dc02660475f35cfcdcd35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jasper=20G=C3=BCldenstein?= Date: Sun, 15 Nov 2020 17:17:29 +0100 Subject: [PATCH] sail documentation --- keil_project/Services/Sail.h | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/keil_project/Services/Sail.h b/keil_project/Services/Sail.h index c981f07..a6cea6c 100644 --- a/keil_project/Services/Sail.h +++ b/keil_project/Services/Sail.h @@ -1,12 +1,27 @@ -//codé par Kévin Cavailles et Jasper Güldenstein - +/** + ****************************************************************************** + * @file IncrEncoder.h + * @author CAVAILLES, Kevin and GÜLDENSTEIN, Jasper + * @brief Service for using the RF Module to transmit characters. + ****************************************************************************** + */ #ifndef SAIL_H #define SAIL_H void SAIL_Init(void); +/** + * @brief Calculates the "optimal" opening angle of the sail depending on the reading of the girouette + * @param girouette_value angle reading where 0 corresponds to the wind blowing from the front + * + * @retval angle between 0 and 90 (degrees) + */ int SAIL_AngleFromGirouette(float girouette_value); -// sets the opening angle of the sail + +/** + * @brief Sets the opening angle of the sail + * @param opening angle of the sail between 0 and 90 (degrees) + */ void SAIL_SetAngle(float angle); #endif