From 11ff5e724fee12bafdfbc2e98976520378827698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jasper=20G=C3=BCldenstein?= Date: Sun, 15 Nov 2020 17:14:00 +0100 Subject: [PATCH] incr incoder documentation --- keil_project/Services/IncrEncoder.h | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/keil_project/Services/IncrEncoder.h b/keil_project/Services/IncrEncoder.h index e9d1f31..baa8973 100644 --- a/keil_project/Services/IncrEncoder.h +++ b/keil_project/Services/IncrEncoder.h @@ -1,13 +1,31 @@ +/** + ****************************************************************************** + * @file IncrEncoder.h + * @author CAVAILLES, Kevin and GÜLDENSTEIN, Jasper + * @brief Service for using the RF Module to transmit characters. + ****************************************************************************** + */ #ifndef INCR_ENCODER_H #define INCR_ENCODER_H - +/** + * @brief Initialziation function for the RF_OUTPUT module. + * Peripherals used: TIM3, EXTI + * Pins used: PA5 (incremental encoder index, interrupt) + * PA6 (incremental encoder channel a, TIM3 channel 1) + * PA7 (incremental encoder channel b, TIM3 channel 2) + */ void INCR_ENCODER_Init(void); +/** + * @brief Indicates whether the index has been passed at least once. + * If this is not the case, the reading is not absolute. + * @retval state (0 or 1) + */ int INCR_ENCODER_IsAbsolute(void); /** - * @brief Returns the angle of the incremental encoder + * @brief Returns the angle reading of the incremental encoder * @retval -180 to 180 where 0 is the incremental encoder pointing towards the back of the boat */ float INCR_ENCODER_GetAngle(void);