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

40 lines
1.1 KiB
C

#ifndef INC_ENCODER_H
#define INC_ENCODER_H
#include "stm32f103xb.h"
/**
* @brief Configure le timer et le pin du gpio pour le codeur incrémental
* @note
* @param TIM_TypeDef timer : le timer à utiliser
* GPIO_TypeDef gpio : le gpio à utiliser pour le zero
* int pin : le pin associé au GPIO pour le zero
* @retval None
*/
void IncrementalEncoder_conf(TIM_TypeDef * timer, GPIO_TypeDef * gpio, int pin);
/**
* @brief Démarre le timer pour le codeur incrémental
* @note
* @param TIM_TypeDef timer : le timer à utiliser
* @retval None
*/
void IncrementalEncoder_start(TIM_TypeDef * timer);
/**
* @brief Récupère l'angle du codeur incrémental associé au timer donné
* @note
* @param TIM_TypeDef timer : le timer à utiliser
* @retval L'angle en degrès
*/
int IncrementalEncoder_getAngle(TIM_TypeDef * timer);
/**
* @brief Récupère la direction du codeur incrémental associé au timer donné
* @note
* @param TIM_TypeDef timer : le timer à utiliser
* @retval la direction actuelle du codeur
*/
enum CounterDirection IncrementalEncoder_getDirection(TIM_TypeDef * timer);
#endif