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

42 lines
1.2 KiB
C

#ifndef DCMOTOR_H
#define DCMOTOR_H
#include "GPIO.h"
#include "Timer.h"
/**
* @brief Configure le Timer et le GPIO du DCmotor
* @note
* @param timer : Timer utilisé pour controler le moteur
* channel : channel du timer
* gpio : GPIO utilisé pour régler le sens du moteur
* pin : Pin pour l'axe Y
* @retval None
*/
void DCMotor_conf(TIM_TypeDef * timer, int channel, GPIO_TypeDef * gpio, int pin);
/**
* @brief Configure le Timer et le GPIO du DCmotor
* @note
* @param timer : Timer utilisé pour controler le moteur
* channel : channel du timer
* gpio : GPIO utilisé pour régler le sens du moteur
* pin : Pin pour l'axe Y
* speed : vitesse voulue
* @retval None
*/
void DCMotor_setSpeed(TIM_TypeDef * timer, int channel, GPIO_TypeDef * gpio, int pin, float speed);
/**
* @brief Récupère la vitesse actuelle du moteur
* @note
* @param timer : Timer utilisé pour controler le moteur
* channel : channel du timer
* gpio : GPIO utilisé pour régler le sens du moteur
* pin : Pin pour l'axe Y
* speed : vitesse voulue
* @retval None
*/
float DCMotor_getSpeed(TIM_TypeDef * timer, int channel, GPIO_TypeDef * gpio, int pin);
#endif