guldenst/projet_voilier
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

incr incoder documentation

Browse source
This commit is contained in:
Jasper Güldenstein 2020-11-15 17:14:00 +01:00
parent db573aee04
commit 11ff5e724f
1 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
keil_project/Services/IncrEncoder.h
View file

@ -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 #ifndef INCR_ENCODER_H
#define 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); 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); 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 * @retval -180 to 180 where 0 is the incremental encoder pointing towards the back of the boat
*/ */
float INCR_ENCODER_GetAngle(void); float INCR_ENCODER_GetAngle(void);