Projet_RT/software/raspberry/superviseur-robot/lib/robot.h

/**
 * \file      robot.h
 * \author    L.Senaneuch
 * \version   1.0
 * \date      06/06/2017
 * \brief     Fonction permettant la communication avec le robot.
 *
 * \details   Ce fichier regroupe des fonctions facilitant la communication avec le robot en utilisant le port serie USART
 */


#ifndef DUMBERC_SERIAL_H_H
#define DUMBERC_SERIAL_H_H

#include <stdio.h>
#include <unistd.h>
#include <fcntl.h>
#include <termios.h>
#include <string.h>
#include <stdlib.h>
#include "definitions.h"


#define serialPort "/dev/ttyS0"

typedef struct
   {
    char header[4];
    char data[20];
   } MessageToRobot;

 /**
 * \brief     Ouvre la communication avec le robot.
 * \details   Ouvre le serial port passé en paramétre. Par defaut cette fonction ouvre le port ttySO connecté au module xbee.
 *             
 * \param    *path    chaine de caractère indiquant le path du port serie à ouvrir.
 * \return    Return -1 si l'ouverture c'est mal passé et 0 si le port est ouvert.
 */
int open_communication_robot(const char * path=serialPort);

 /**
 * \brief      Ferme la communication avec le robot.
 * \details    Ferme le descripteur de fichier du port serie contrôlant le robot.
 *             
 * \param     void	aucun 
 * \return    Retourne -1 en cas d'erreur ou 0 en cas de fermeture effectué
 */
int close_communication_robot(void);

 /**
 * \brief      Envoi une commande au robot et attends sa réponse.
 * \details    Envoi une commande au robot en ajoutant le checksum et lis la réponse du robot en verifiant le checksum.
			   Le premier paramétre \a cmd correspond au type de commande ex : PING, SETMOVE ...
			   Le second paramétre  \a *arg correspond aux arguments à la commande ex : SETMOVE, "100"
			   La fonction retourne un code confirmation transmise par le robot (ROBOT_CHEKSUM, ROBOT_ERROR, ROBOT_TIMED_OUT, ROBOT_OK, ROBOT_UKNOW_CMD)
 *             
 * \param    cmd    Entête de la commande
 * \param    *arg   Argument de la commande 
 * \return   retourne un code confirmation.
 */
int send_command_to_robot(char cmd, const char * arg=NULL);


#endif //DUMBERC_SERIAL_H_H