sail documentation
This commit is contained in:
parent
11ff5e724f
commit
2b236173af
1 changed files with 18 additions and 3 deletions
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue