m2mb_gnss.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2M_M2MB_GNSS_API_H
#define  M2M_M2MB_GNSS_API_H
 
 
/* Global declarations ==========================================================================*/
 
 
/* Global typedefs ==============================================================================*/
typedef struct M2MB_GNSS_HANDLE_TAG *M2MB_GNSS_HANDLE;
 
// Indications
typedef enum
{
  M2MB_GNSS_INDICATION_POSITION_REPORT,
  M2MB_GNSS_INDICATION_NMEA_REPORT
} M2MB_GNSS_IND_E;
 
// Services
typedef enum
{
  M2MB_GNSS_SERVICE_POSITION_REPORT,
  M2MB_GNSS_SERVICE_NMEA_REPORT
} M2MB_GNSS_SERVICE_E;
 
// Struct for M2MB_GNSS_SERVICE_POSITION_REPORT service
typedef struct
{
  UINT8 codingType;  //Coding of Velocity Type (see 3GPP GAD spec.).
 
  FLOAT64 speed_horizontal;
  FLOAT64 bearing;
} M2MB_GNSS_POS_REP_VELOCITY_T;
 
typedef struct
{
  FLOAT64 speed_horizontal;
  FLOAT64 speed_vertical;
 
  FLOAT64 speed;  //The result.
} M2MB_GNSS_POS_REP_SPEED_T;
 
typedef struct
{
  BOOLEAN latitude_valid;
  FLOAT64 latitude;
 
  BOOLEAN longitude_valid;
  FLOAT64 longitude;
 
  BOOLEAN altitude_valid;
  FLOAT64 altitude;
 
  BOOLEAN uncertainty_valid;
  FLOAT64 uncertainty;
 
  BOOLEAN velocity_valid;
  M2MB_GNSS_POS_REP_VELOCITY_T velocity;
 
  BOOLEAN timestamp_valid;
  UINT64 timestamp;
 
  BOOLEAN speed_valid;
  M2MB_GNSS_POS_REP_SPEED_T speed;  //NOT PRESENT! => I need to calculate it from speed_horizontal and speed_vertical.
} M2MB_GNSS_POSITION_REPORT_INFO_T;
 
// Callback
typedef void ( *m2mb_gnss_callback )( M2MB_GNSS_HANDLE handle, M2MB_GNSS_IND_E event, UINT16 resp_size, void *resp, void *userdata );
 
 
/* Global functions =============================================================================*/
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_init( M2MB_GNSS_HANDLE *pHandle, m2mb_gnss_callback callback, void *userdata );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_deinit( M2MB_GNSS_HANDLE handle );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_enable( M2MB_GNSS_HANDLE handle, M2MB_GNSS_SERVICE_E service );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_disable( M2MB_GNSS_HANDLE handle, M2MB_GNSS_SERVICE_E service );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_start( M2MB_GNSS_HANDLE handle );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_RESULT_E m2mb_gnss_stop( M2MB_GNSS_HANDLE handle );
 
 
#endif  /* M2M_M2MB_GNSS_API_H */