spartn.hpp File Reference

Fixposition SDK: Parser SPARTN routines and types. More...

#include <cstdint>

Include dependency graph for spartn.hpp:

Go to the source code of this file.

Namespaces
namespace	fpsdk
	Fixposition SDK.
namespace	fpsdk::common
	Fixposition SDK: Common library.
namespace	fpsdk::common::parser
	Parser.
namespace	fpsdk::common::parser::spartn
	Parser SPARTN routines and types.

Functions
constexpr uint8_t	fpsdk::common::parser::spartn::SpartnType (const uint8_t *msg)
	Get SPARTN message type.
constexpr uint8_t	fpsdk::common::parser::spartn::SpartnSubType (const uint8_t *msg)
	Get SPARTN message sub-type.
bool	fpsdk::common::parser::spartn::SpartnGetMessageName (char *name, const std::size_t size, const uint8_t *msg, const std::size_t msg_size)
	Get SPARTN message name.
bool	fpsdk::common::parser::spartn::SpartnGetMessageInfo (char *info, const std::size_t size, const uint8_t *msg, const std::size_t msg_size)
	Get SPARTN message info.
const char *	fpsdk::common::parser::spartn::SpartnGetTypeDesc (const uint16_t type, const uint16_t subtype=0xffff)
	Get description for a SPARTN message type.

Variables
static constexpr uint8_t	fpsdk::common::parser::spartn::SPARTN_PREAMBLE = 0x73
	SPARTN protocol preamble.
static constexpr std::size_t	fpsdk::common::parser::spartn::SPARTN_MIN_HEAD_SIZE = 8
	Minimal header size of a SPARTN message.
SPARTN messages (names and IDs)
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_MSGID = 0
	SPARTN-OCB message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_STRID = "SPARTN-OCB"
	SPARTN-OCB message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_MSGID = 1
	SPARTN-HPAC message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_STRID = "SPARTN-HPAC"
	SPARTN-HPAC message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_GAD_MSGID = 2
	SPARTN-GAD message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_GAD_STRID = "SPARTN-GAD"
	SPARTN-GAD message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_BPAC_MSGID = 3
	SPARTN-BPAC message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_BPAC_STRID = "SPARTN-BPAC"
	SPARTN-BPAC message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_EAS_MSGID = 4
	SPARTN-EAS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_EAS_STRID = "SPARTN-EAS"
	SPARTN-EAS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_PROP_MSGID = 120
	SPARTN-PROP message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_PROP_STRID = "SPARTN-PROP"
	SPARTN-PROP message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_GPS_SUBID = 0
	SPARTN-OCB-GPS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_GPS_STRID = "SPARTN-OCB-GPS"
	SPARTN-OCB-GPS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_GLO_SUBID = 1
	SPARTN-OCB-GLO message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_GLO_STRID = "SPARTN-OCB-GLO"
	SPARTN-OCB-GLO message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_GAL_SUBID = 2
	SPARTN-OCB-GAL message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_GAL_STRID = "SPARTN-OCB-GAL"
	SPARTN-OCB-GAL message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_BDS_SUBID = 3
	SPARTN-OCB-BDS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_BDS_STRID = "SPARTN-OCB-BDS"
	SPARTN-OCB-BDS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_OCB_QZSS_SUBID = 4
	SPARTN-OCB-QZSS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_OCB_QZSS_STRID = "SPARTN-OCB-QZSS"
	SPARTN-OCB-QZSS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_GPS_SUBID = 0
	SPARTN-HPAC-GPS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_GPS_STRID = "SPARTN-HPAC-GPS"
	SPARTN-HPAC-GPS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_GLO_SUBID = 1
	SPARTN-HPAC-GLO message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_GLO_STRID = "SPARTN-HPAC-GLO"
	SPARTN-HPAC-GLO message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_GAL_SUBID = 2
	SPARTN-HPAC-GAL message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_GAL_STRID = "SPARTN-HPAC-GAL"
	SPARTN-HPAC-GAL message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_BDS_SUBID = 3
	SPARTN-HPAC-BDS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_BDS_STRID = "SPARTN-HPAC-BDS"
	SPARTN-HPAC-BDS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_HPAC_QZSS_SUBID = 4
	SPARTN-HPAC-QZSS message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_HPAC_QZSS_STRID = "SPARTN-HPAC-QZSS"
	SPARTN-HPAC-QZSS message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_GAD_GAD_SUBID = 0
	SPARTN-GAD-GAD message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_GAD_GAD_STRID = "SPARTN-GAD-GAD"
	SPARTN-GAD-GAD message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_BPAC_POLY_SUBID = 0
	SPARTN-BPAC-POLY message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_BPAC_POLY_STRID = "SPARTN-BPAC-POLY"
	SPARTN-BPAC-POLY message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_EAS_KEY_SUBID = 0
	SPARTN-EAS-KEY message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_EAS_KEY_STRID = "SPARTN-EAS-KEY"
	SPARTN-EAS-KEY message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_EAS_GROUP_SUBID = 1
	SPARTN-EAS-GROUP message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_EAS_GROUP_STRID = "SPARTN-EAS-GROUP"
	SPARTN-EAS-GROUP message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_PROP_EST_SUBID = 0
	SPARTN-PROP-EST message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_PROP_EST_STRID = "SPARTN-PROP-EST"
	SPARTN-PROP-EST message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_PROP_UBLOX_SUBID = 1
	SPARTN-PROP-UBLOX message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_PROP_UBLOX_STRID = "SPARTN-PROP-UBLOX"
	SPARTN-PROP-UBLOX message name.
static constexpr uint16_t	fpsdk::common::parser::spartn::SPARTN_PROP_SWIFT_SUBID = 2
	SPARTN-PROP-SWIFT message ID.
static constexpr const char *	fpsdk::common::parser::spartn::SPARTN_PROP_SWIFT_STRID = "SPARTN-PROP-SWIFT"
	SPARTN-PROP-SWIFT message name.

Detailed Description

Fixposition SDK: Parser SPARTN routines and types.

* ___    ___
* \  \  /  /
*  \  \/  /   Copyright (c) Fixposition AG (www.fixposition.com) and contributors
*  /  /\  \   License: see the LICENSE file
* /__/  \__\
*
* Based on work by flipflip (https://github.com/phkehl)
* The information on message structures, IDs, descriptions etc. in this file are from publicly available data, such as:
* - Secure Position Augmentation for Real-Time Navigation (SPARTN) Interface Control Document
*   (https://www.spartnformat.org)
* 

Definition in file spartn.hpp.