WNMEA  1.0.0
Warcomeb NMEA 0183 Parsing Library based on libohiboard

Data Structures

struct  _WNMEA_Message_t
 
struct  _WNMEA_MessageRMC_t
 
struct  _WNMEA_MessageGGA_t
 
struct  _WNMEA_MessageZDA_t
 
struct  _WNMEA_MessageParsed_t
 
struct  _WNMEA_MessageCallback_t
 

Macros

#define WNMEA_PROJECT_NAME   "WNMEA"
 
#define WNMEA_MESSAGE_TYPE_LENGTH   10
 
#define WNMEA_MESSAGE_BODY_LENGTH   100
 
#define WNMEA_MESSAGE_CRC_LENGTH   2
 
#define WNMEA_BUFFER_DIMENSION   0x03FFu
 

Typedefs

typedef float WNMEA_Coordinate_t
 
typedef enum _WNMEA_Errors_t WNMEA_Error_t
 
typedef enum _WNMEA_Constellation_t WNMEA_Constellation_t
 
typedef enum _WNMEA_MessageType_t WNMEA_MessageType_t
 
typedef enum _WNMEA_CardinalSide_t WNMEA_CardinalSide_t
 
typedef enum _WNMEA_PositionType_t WNMEA_PositionType_t
 
typedef enum _WNMEA_FixQuality_t WNMEA_FixQuality_t
 
typedef struct _WNMEA_Message_t WNMEA_Message_t
 
typedef struct _WNMEA_MessageRMC_t WNMEA_MessageRMC_t
 
typedef struct _WNMEA_MessageGGA_t WNMEA_MessageGGA_t
 
typedef struct _WNMEA_MessageZDA_t WNMEA_MessageZDA_t
 
typedef struct _WNMEA_MessageParsed_t WNMEA_MessageParsed_t
 
typedef struct _WNMEA_MessageParsed_tWNMEA_MessageParsedHandle_t
 
typedef void(* WNMEA_pFunctionCallback) (WNMEA_MessageParsed_t msg, WNMEA_MessageType_t type)
 
typedef struct _WNMEA_MessageCallback_t WNMEA_MessageCallback_t
 

Enumerations

enum  _WNMEA_Errors_t { WNMEA_ERROR_SUCCESS = 0x0000, WNMEA_ERROR_WRONG_MESSAGE = 0x0001, WNMEA_ERROR_MESSAGE_PARSING = 0x0002, WNMEA_ERROR_MESSAGE_READY = 0xFFFF }
 
enum  _WNMEA_Constellation_t {
  WNMEA_CONSTELLATION_GPS, WNMEA_CONSTELLATION_GLONASS, WNMEA_CONSTELLATION_GALILEO, WNMEA_CONSTELLATION_BEIDOU,
  WNMEA_CONSTELLATION_NAVIC, WNMEA_CONSTELLATION_MULTIPLE, WNMEA_CONSTELLATION_UNKNOW
}
 
enum  _WNMEA_MessageType_t {
  WNMEA_MESSAGETYPE_RMC, WNMEA_MESSAGETYPE_GGA, WNMEA_MESSAGETYPE_GLL, WNMEA_MESSAGETYPE_GSV,
  WNMEA_MESSAGETYPE_GSA, WNMEA_MESSAGETYPE_ZDA, WNMEA_MESSAGETYPE_UNKNOW
}
 
enum  _WNMEA_CardinalSide_t {
  WNMEA_CARDINALSIDE_NORTH, WNMEA_CARDINALSIDE_SOUTH, WNMEA_CARDINALSIDE_EAST, WNMEA_CARDINALSIDE_WEST,
  WNMEA_CARDINALSIDE_UNKNOW
}
 
enum  _WNMEA_PositionType_t { WNMEA_POSITIONTYPE_VALID, WNMEA_POSITIONTYPE_INVALID }
 
enum  _WNMEA_FixQuality_t { WNMEA_FIXQUALITY_INVALID = 0, WNMEA_FIXQUALITY_FIX = 1, WNMEA_FIXQUALITY_DIFFERENTIAL_FIX = 2 }
 

Variables

static const Utility_Version_t WNMEA_FIRMWARE_VERSION
 

Detailed Description

Macro Definition Documentation

◆ WNMEA_BUFFER_DIMENSION

#define WNMEA_BUFFER_DIMENSION   0x03FFu

◆ WNMEA_MESSAGE_BODY_LENGTH

#define WNMEA_MESSAGE_BODY_LENGTH   100

◆ WNMEA_MESSAGE_CRC_LENGTH

#define WNMEA_MESSAGE_CRC_LENGTH   2

◆ WNMEA_MESSAGE_TYPE_LENGTH

#define WNMEA_MESSAGE_TYPE_LENGTH   10

◆ WNMEA_PROJECT_NAME

#define WNMEA_PROJECT_NAME   "WNMEA"

Typedef Documentation

◆ WNMEA_CardinalSide_t

List of all cardinal side position.

◆ WNMEA_Constellation_t

List of all constellation type.

◆ WNMEA_Coordinate_t

typedef float WNMEA_Coordinate_t

◆ WNMEA_Error_t

List of all possible errors.

◆ WNMEA_FixQuality_t

Fix quality enumeration. It is used into GGA packet.

◆ WNMEA_Message_t

Generic structure of NMEA 0183 packet.

◆ WNMEA_MessageCallback_t

Set of all callback that can be used when the device receive and parse a valid message.

◆ WNMEA_MessageGGA_t

GGA Sentences - Global Positioning System Fix Data

◆ WNMEA_MessageParsed_t

Parsed message informations into one type.

◆ WNMEA_MessageParsedHandle_t

◆ WNMEA_MessageRMC_t

RMC Sentences - Recommended minimum specific GPS/Transit data

◆ WNMEA_MessageType_t

List of all accepted NMEA 0183 message.

◆ WNMEA_MessageZDA_t

ZDA Sentences - Date & Time

◆ WNMEA_pFunctionCallback

typedef void(* WNMEA_pFunctionCallback) (WNMEA_MessageParsed_t msg, WNMEA_MessageType_t type)

Callback function type used to manage a valid parsed packet.

◆ WNMEA_PositionType_t

Position fix validity enumeration. It is used into RMC packet.

Enumeration Type Documentation

◆ _WNMEA_CardinalSide_t

List of all cardinal side position.

Enumerator
WNMEA_CARDINALSIDE_NORTH 
WNMEA_CARDINALSIDE_SOUTH 
WNMEA_CARDINALSIDE_EAST 
WNMEA_CARDINALSIDE_WEST 
WNMEA_CARDINALSIDE_UNKNOW 

◆ _WNMEA_Constellation_t

List of all constellation type.

Enumerator
WNMEA_CONSTELLATION_GPS 
WNMEA_CONSTELLATION_GLONASS 
WNMEA_CONSTELLATION_GALILEO 
WNMEA_CONSTELLATION_BEIDOU 
WNMEA_CONSTELLATION_NAVIC 
WNMEA_CONSTELLATION_MULTIPLE 
WNMEA_CONSTELLATION_UNKNOW 

◆ _WNMEA_Errors_t

List of all possible errors.

Enumerator
WNMEA_ERROR_SUCCESS 
WNMEA_ERROR_WRONG_MESSAGE 
WNMEA_ERROR_MESSAGE_PARSING 
WNMEA_ERROR_MESSAGE_READY 

◆ _WNMEA_FixQuality_t

Fix quality enumeration. It is used into GGA packet.

Enumerator
WNMEA_FIXQUALITY_INVALID 
WNMEA_FIXQUALITY_FIX 
WNMEA_FIXQUALITY_DIFFERENTIAL_FIX 

◆ _WNMEA_MessageType_t

List of all accepted NMEA 0183 message.

Enumerator
WNMEA_MESSAGETYPE_RMC 
WNMEA_MESSAGETYPE_GGA 
WNMEA_MESSAGETYPE_GLL 
WNMEA_MESSAGETYPE_GSV 
WNMEA_MESSAGETYPE_GSA 
WNMEA_MESSAGETYPE_ZDA 
WNMEA_MESSAGETYPE_UNKNOW 

◆ _WNMEA_PositionType_t

Position fix validity enumeration. It is used into RMC packet.

Enumerator
WNMEA_POSITIONTYPE_VALID 
WNMEA_POSITIONTYPE_INVALID 

Variable Documentation

◆ WNMEA_FIRMWARE_VERSION

const Utility_Version_t WNMEA_FIRMWARE_VERSION
static
WARCOMEB_WNMEA_LIBRARY_VERSION_MINOR
#define WARCOMEB_WNMEA_LIBRARY_VERSION_MINOR
Definition: wnmea-types.h:37
WARCOMEB_WNMEA_LIBRARY_TIME
#define WARCOMEB_WNMEA_LIBRARY_TIME
Definition: wnmea-types.h:39
WARCOMEB_WNMEA_LIBRARY_VERSION_MAJOR
#define WARCOMEB_WNMEA_LIBRARY_VERSION_MAJOR
Definition: wnmea-types.h:36
WARCOMEB_WNMEA_LIBRARY_VERSION_BUG
#define WARCOMEB_WNMEA_LIBRARY_VERSION_BUG
Definition: wnmea-types.h:38