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

37 lines
1.2 KiB
C

#ifndef RFEMITTER_H
#define RFEMITTER_H
#include "USART.h"
/**
* @brief Configure l'USART et le pin du gpio pour l'émetteur
* @note
* @param USART_TypeDef usart : l'usart à utiliser pour transmettre les informations
* GPIO_TypeDef gpioTXEnable : le gpio à utiliser pour activer l'emetteur
* int pinTXEnable : le pin associé au GPIO
* @retval None
*/
void RFEmitter_conf(USART_TypeDef * usart, GPIO_TypeDef *gpioTXEnable, int pinTXEnable);
/**
* @brief Démarre l'USART l'émetteur
* @note
* @param USART_TypeDef usart : l'usart à utiliser pour transmettre les informations
* @retval None
*/
void RFEmitter_start(USART_TypeDef * usart);
/**
* @brief Envoie le message donnée par l'émetteur
* @note
* @param USART_TypeDef usart : l'usart à utiliser pour transmettre les informations
* char message : le message à envoyer
* int longueur : la longueur du message
* GPIO_TypeDef gpioTXEnable : le gpio à utiliser pour activer l'emetteur
* int pinTXEnable : le pin associé au GPIO
* @retval None
*/
void RFEmitter_send(USART_TypeDef * usart, char * message, int longueur, GPIO_TypeDef *gpioTXEnable, int pinTXEnable);
#endif