WNMEA  1.0.0
Warcomeb NMEA 0183 Parsing Library based on libohiboard
wnmea-types.h File Reference

All public types of library. More...

#include "board.h"
#include "firmware.h"

Go to the source code of this file.

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 WARCOMEB_WNMEA_LIBRARY_VERSION_MAJOR   (0x1ul)
 
#define WARCOMEB_WNMEA_LIBRARY_VERSION_MINOR   (0x0ul)
 
#define WARCOMEB_WNMEA_LIBRARY_VERSION_BUG   (0x0ul)
 
#define WARCOMEB_WNMEA_LIBRARY_TIME   0
 
#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

All public types of library.

Macro Definition Documentation

◆ WARCOMEB_WNMEA_LIBRARY_TIME

#define WARCOMEB_WNMEA_LIBRARY_TIME   0

◆ WARCOMEB_WNMEA_LIBRARY_VERSION_BUG

#define WARCOMEB_WNMEA_LIBRARY_VERSION_BUG   (0x0ul)

◆ WARCOMEB_WNMEA_LIBRARY_VERSION_MAJOR

#define WARCOMEB_WNMEA_LIBRARY_VERSION_MAJOR   (0x1ul)

◆ WARCOMEB_WNMEA_LIBRARY_VERSION_MINOR

#define WARCOMEB_WNMEA_LIBRARY_VERSION_MINOR   (0x0ul)