GPS.h

Go to the documentation of this file.

#ifndef GPS_H_
#define GPS_H_


#include "Bitmanip.h"           // due to: the bit manipulations macros
#include "UART1.h"              // due to: serial communications functions
#include "Time.h"               // due to: the software rtc
#include "Dinamic_Array.h"      // due to: dinamic array
#include "GPSpacket.h"          // due to: tGPSInfoArray types and it's functions           
#include "Ports.h"              // due to: Ports_setPort2Pin function

//*****************************************************************************
//
// Types and definitions
//
//*****************************************************************************


#ifndef DEFINE_TBOOLEAN                 // define unsigned char as tBoolean in only that case when it hasn't been defined yet somewhere else in the scope

typedef unsigned char tBoolean;         // use as bool
#define DEFINE_TBOOLEAN

#endif                                  // DEFINE_TBOOLEAN


// number of the attempts to send one command to the gps module
#define ATTEMPT_NUMBER 5

// size of the buffer that contians the response of the gps module
#define GPS_RESPONSE_BUFFER_SIZE  1024

// maximum size of one nmea sentence
#define PACKET_SIZE 80


typedef enum{
    
    GPS_Uninizialized = 0,
    GPS_SendCommand,
    GPS_CommandSent,
    GPS_StarWaitingForTheAnswer,
    GPS_WaitingForTheAnswer,
    GPS_InitError,
    GPS_Inizialized
    
}tGPS_state;


typedef enum{
    
    NMEA_NODATA = 0,                // No data. Packet not available.
    NMEA_UNKNOWN,                   // Packet received but is not known.
    NMEA_GPGGA,                     // Global Positinoning System fix data 
    NMEA_GPGLL,                     // Geographic position - latitude/longitude
    NMEA_GPGSA,                     // GNSS DOP and Active Satellites
    NMEA_GPGSV,                     // GNSS Satellites in view
    NMEA_GPRMC,                     // Recomended Minimum Specific GNSS Data
    NMEA_GPVTG,                     // Course Over Ground and Ground Speed
    NMEA_ACK,                       // ACK response from the gps module
    NMEA_NACK                       // NACK response from the gps module
    
}tNMEA_messages;


typedef void (*tpfGPSHttpPostCallbackFunction) (char*, char*, char*, char*, unsigned int);


//*****************************************************************************
//
// Function declarations
//
//*****************************************************************************


void GPS_executeGPS(void);


void GPS_initGPS(void);


void GPS_appendResponse(const char* pcResponse);


void GPS_setupGPS(void);


tBoolean GPS_isCommandSent(void);


tBoolean GPS_isResponseBufferFull(void);


void GPS_setDeadline(unsigned int uiDeadline);


tBoolean GPS_isDeadlinePassed(void);


void GPS_setState(tGPS_state newState);


void GPS_setNextState(tGPS_state newState);


tGPS_state GPS_getGPSstate(void);


void GPS_setGPShttpPostCallbackFunction(tpfGPSHttpPostCallbackFunction pfCallbackGPRShttpPost);


void GPS_addCommand(const unsigned char* pcCommand);


void GPS_goToNextCommand(void);


tBoolean GPS_isCommandAvaiable(void);


void GPS_clearResponseBuffer(void);


void GPS_clearGPSInfoPacket(tGPSInfo* pGPSInfoPacket);


void GPS_sendCommand(void);


void GPS_processCommand(void);


tNMEA_messages GPS_NMEAProcess(char* cpNmeaPacket);


void GPS_ProcessGPGGA(const char* pcFoundPacket, tGPSInfo* pGPSInfoPacket);


#endif /*GPS_H_*/