Fixposition SDK 0.0.0-heads/main-0-g90a51ff
Collection of c++ libraries and apps for use with Fixposition products
Loading...
Searching...
No Matches
fpsdk::common::parser::spartn Namespace Reference

Parser SPARTN routines and types. More...

Functions

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

Variables

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

Detailed Description

Parser SPARTN routines and types.

Function Documentation

◆ SpartnType()

uint8_t fpsdk::common::parser::spartn::SpartnType ( const uint8_t * msg)
constexpr

Get SPARTN message type.

Parameters
[in]msgPointer to the start of the message
Note
No check on the data provided is done. The caller must ensure that the data is a valid SPARTN message.
Returns
the SPARTN message type

Definition at line 54 of file spartn.hpp.

◆ SpartnSubType()

uint8_t fpsdk::common::parser::spartn::SpartnSubType ( const uint8_t * msg)
constexpr

Get SPARTN message sub-type.

Parameters
[in]msgPointer to the start of the message
Note
No check on the data provided is done. The caller must ensure that the data is a valid SPARTN message.
Returns
the SPARTN message sub-type

Definition at line 68 of file spartn.hpp.

◆ SpartnGetMessageName()

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.

Generates a name (string) in the form "SPARTN-TYPEN_S", where N is the message type and S is the sub-type. For example: "SPARTN-TYPE1_2".

Parameters
[out]nameString to write the name to
[in]sizeSize of name (incl. nul termination)
[in]msgPointer to the SPARTN message
[in]msg_sizeSize of the msg
Note
No check on the data provided is done. The caller must ensure that the data is a valid SPARTN message.
Returns
true if message name was generated, false if name buffer was too small

◆ SpartnGetMessageInfo()

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.

This stringifies the content of some SPARTN messages, for debugging.

Parameters
[out]infoString to write the info to
[in]sizeSize of name (incl. nul termination)
[in]msgPointer to the SPARTN message
[in]msg_sizeSize of the msg
Note
No check on the data provided is done. The caller must ensure that the data is a valid SPARTN message.
Returns
true if message info was generated (even if info is empty), false if name buffer was too small

◆ SpartnGetTypeDesc()

const char * fpsdk::common::parser::spartn::SpartnGetTypeDesc ( const uint16_t type,
const uint16_t subtype = 0xffff )

Get description for a SPARTN message type.

Parameters
[in]typeMessage type
[in]subtypeMessage sub-type (if appropriate)
Returns
the description of the message type, if available, NULL otherwise

Variable Documentation

◆ SPARTN_PREAMBLE

uint8_t fpsdk::common::parser::spartn::SPARTN_PREAMBLE = 0x73
staticconstexpr

SPARTN protocol preamble.

Definition at line 42 of file spartn.hpp.

◆ SPARTN_MIN_HEAD_SIZE

std::size_t fpsdk::common::parser::spartn::SPARTN_MIN_HEAD_SIZE = 8
staticconstexpr

Minimal header size of a SPARTN message.

Definition at line 43 of file spartn.hpp.

◆ SPARTN_OCB_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_MSGID = 0
staticconstexpr

SPARTN-OCB message ID.

Definition at line 123 of file spartn.hpp.

◆ SPARTN_OCB_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_STRID = "SPARTN-OCB"
staticconstexpr

SPARTN-OCB message name.

Definition at line 124 of file spartn.hpp.

◆ SPARTN_HPAC_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_MSGID = 1
staticconstexpr

SPARTN-HPAC message ID.

Definition at line 125 of file spartn.hpp.

◆ SPARTN_HPAC_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_STRID = "SPARTN-HPAC"
staticconstexpr

SPARTN-HPAC message name.

Definition at line 126 of file spartn.hpp.

◆ SPARTN_GAD_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_GAD_MSGID = 2
staticconstexpr

SPARTN-GAD message ID.

Definition at line 127 of file spartn.hpp.

◆ SPARTN_GAD_STRID

const char* fpsdk::common::parser::spartn::SPARTN_GAD_STRID = "SPARTN-GAD"
staticconstexpr

SPARTN-GAD message name.

Definition at line 128 of file spartn.hpp.

◆ SPARTN_BPAC_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_BPAC_MSGID = 3
staticconstexpr

SPARTN-BPAC message ID.

Definition at line 129 of file spartn.hpp.

◆ SPARTN_BPAC_STRID

const char* fpsdk::common::parser::spartn::SPARTN_BPAC_STRID = "SPARTN-BPAC"
staticconstexpr

SPARTN-BPAC message name.

Definition at line 130 of file spartn.hpp.

◆ SPARTN_EAS_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_EAS_MSGID = 4
staticconstexpr

SPARTN-EAS message ID.

Definition at line 131 of file spartn.hpp.

◆ SPARTN_EAS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_EAS_STRID = "SPARTN-EAS"
staticconstexpr

SPARTN-EAS message name.

Definition at line 132 of file spartn.hpp.

◆ SPARTN_PROP_MSGID

uint16_t fpsdk::common::parser::spartn::SPARTN_PROP_MSGID = 120
staticconstexpr

SPARTN-PROP message ID.

Definition at line 133 of file spartn.hpp.

◆ SPARTN_PROP_STRID

const char* fpsdk::common::parser::spartn::SPARTN_PROP_STRID = "SPARTN-PROP"
staticconstexpr

SPARTN-PROP message name.

Definition at line 134 of file spartn.hpp.

◆ SPARTN_OCB_GPS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_GPS_SUBID = 0
staticconstexpr

SPARTN-OCB-GPS message ID.

Definition at line 135 of file spartn.hpp.

◆ SPARTN_OCB_GPS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_GPS_STRID = "SPARTN-OCB-GPS"
staticconstexpr

SPARTN-OCB-GPS message name.

Definition at line 136 of file spartn.hpp.

◆ SPARTN_OCB_GLO_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_GLO_SUBID = 1
staticconstexpr

SPARTN-OCB-GLO message ID.

Definition at line 137 of file spartn.hpp.

◆ SPARTN_OCB_GLO_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_GLO_STRID = "SPARTN-OCB-GLO"
staticconstexpr

SPARTN-OCB-GLO message name.

Definition at line 138 of file spartn.hpp.

◆ SPARTN_OCB_GAL_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_GAL_SUBID = 2
staticconstexpr

SPARTN-OCB-GAL message ID.

Definition at line 139 of file spartn.hpp.

◆ SPARTN_OCB_GAL_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_GAL_STRID = "SPARTN-OCB-GAL"
staticconstexpr

SPARTN-OCB-GAL message name.

Definition at line 140 of file spartn.hpp.

◆ SPARTN_OCB_BDS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_BDS_SUBID = 3
staticconstexpr

SPARTN-OCB-BDS message ID.

Definition at line 141 of file spartn.hpp.

◆ SPARTN_OCB_BDS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_BDS_STRID = "SPARTN-OCB-BDS"
staticconstexpr

SPARTN-OCB-BDS message name.

Definition at line 142 of file spartn.hpp.

◆ SPARTN_OCB_QZSS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_OCB_QZSS_SUBID = 4
staticconstexpr

SPARTN-OCB-QZSS message ID.

Definition at line 143 of file spartn.hpp.

◆ SPARTN_OCB_QZSS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_OCB_QZSS_STRID = "SPARTN-OCB-QZSS"
staticconstexpr

SPARTN-OCB-QZSS message name.

Definition at line 144 of file spartn.hpp.

◆ SPARTN_HPAC_GPS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_GPS_SUBID = 0
staticconstexpr

SPARTN-HPAC-GPS message ID.

Definition at line 145 of file spartn.hpp.

◆ SPARTN_HPAC_GPS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_GPS_STRID = "SPARTN-HPAC-GPS"
staticconstexpr

SPARTN-HPAC-GPS message name.

Definition at line 146 of file spartn.hpp.

◆ SPARTN_HPAC_GLO_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_GLO_SUBID = 1
staticconstexpr

SPARTN-HPAC-GLO message ID.

Definition at line 147 of file spartn.hpp.

◆ SPARTN_HPAC_GLO_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_GLO_STRID = "SPARTN-HPAC-GLO"
staticconstexpr

SPARTN-HPAC-GLO message name.

Definition at line 148 of file spartn.hpp.

◆ SPARTN_HPAC_GAL_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_GAL_SUBID = 2
staticconstexpr

SPARTN-HPAC-GAL message ID.

Definition at line 149 of file spartn.hpp.

◆ SPARTN_HPAC_GAL_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_GAL_STRID = "SPARTN-HPAC-GAL"
staticconstexpr

SPARTN-HPAC-GAL message name.

Definition at line 150 of file spartn.hpp.

◆ SPARTN_HPAC_BDS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_BDS_SUBID = 3
staticconstexpr

SPARTN-HPAC-BDS message ID.

Definition at line 151 of file spartn.hpp.

◆ SPARTN_HPAC_BDS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_BDS_STRID = "SPARTN-HPAC-BDS"
staticconstexpr

SPARTN-HPAC-BDS message name.

Definition at line 152 of file spartn.hpp.

◆ SPARTN_HPAC_QZSS_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_HPAC_QZSS_SUBID = 4
staticconstexpr

SPARTN-HPAC-QZSS message ID.

Definition at line 153 of file spartn.hpp.

◆ SPARTN_HPAC_QZSS_STRID

const char* fpsdk::common::parser::spartn::SPARTN_HPAC_QZSS_STRID = "SPARTN-HPAC-QZSS"
staticconstexpr

SPARTN-HPAC-QZSS message name.

Definition at line 154 of file spartn.hpp.

◆ SPARTN_GAD_GAD_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_GAD_GAD_SUBID = 0
staticconstexpr

SPARTN-GAD-GAD message ID.

Definition at line 155 of file spartn.hpp.

◆ SPARTN_GAD_GAD_STRID

const char* fpsdk::common::parser::spartn::SPARTN_GAD_GAD_STRID = "SPARTN-GAD-GAD"
staticconstexpr

SPARTN-GAD-GAD message name.

Definition at line 156 of file spartn.hpp.

◆ SPARTN_BPAC_POLY_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_BPAC_POLY_SUBID = 0
staticconstexpr

SPARTN-BPAC-POLY message ID.

Definition at line 157 of file spartn.hpp.

◆ SPARTN_BPAC_POLY_STRID

const char* fpsdk::common::parser::spartn::SPARTN_BPAC_POLY_STRID = "SPARTN-BPAC-POLY"
staticconstexpr

SPARTN-BPAC-POLY message name.

Definition at line 158 of file spartn.hpp.

◆ SPARTN_EAS_KEY_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_EAS_KEY_SUBID = 0
staticconstexpr

SPARTN-EAS-KEY message ID.

Definition at line 159 of file spartn.hpp.

◆ SPARTN_EAS_KEY_STRID

const char* fpsdk::common::parser::spartn::SPARTN_EAS_KEY_STRID = "SPARTN-EAS-KEY"
staticconstexpr

SPARTN-EAS-KEY message name.

Definition at line 160 of file spartn.hpp.

◆ SPARTN_EAS_GROUP_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_EAS_GROUP_SUBID = 1
staticconstexpr

SPARTN-EAS-GROUP message ID.

Definition at line 161 of file spartn.hpp.

◆ SPARTN_EAS_GROUP_STRID

const char* fpsdk::common::parser::spartn::SPARTN_EAS_GROUP_STRID = "SPARTN-EAS-GROUP"
staticconstexpr

SPARTN-EAS-GROUP message name.

Definition at line 162 of file spartn.hpp.

◆ SPARTN_PROP_EST_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_PROP_EST_SUBID = 0
staticconstexpr

SPARTN-PROP-EST message ID.

Definition at line 163 of file spartn.hpp.

◆ SPARTN_PROP_EST_STRID

const char* fpsdk::common::parser::spartn::SPARTN_PROP_EST_STRID = "SPARTN-PROP-EST"
staticconstexpr

SPARTN-PROP-EST message name.

Definition at line 164 of file spartn.hpp.

◆ SPARTN_PROP_UBLOX_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_PROP_UBLOX_SUBID = 1
staticconstexpr

SPARTN-PROP-UBLOX message ID.

Definition at line 165 of file spartn.hpp.

◆ SPARTN_PROP_UBLOX_STRID

const char* fpsdk::common::parser::spartn::SPARTN_PROP_UBLOX_STRID = "SPARTN-PROP-UBLOX"
staticconstexpr

SPARTN-PROP-UBLOX message name.

Definition at line 166 of file spartn.hpp.

◆ SPARTN_PROP_SWIFT_SUBID

uint16_t fpsdk::common::parser::spartn::SPARTN_PROP_SWIFT_SUBID = 2
staticconstexpr

SPARTN-PROP-SWIFT message ID.

Definition at line 167 of file spartn.hpp.

◆ SPARTN_PROP_SWIFT_STRID

const char* fpsdk::common::parser::spartn::SPARTN_PROP_SWIFT_STRID = "SPARTN-PROP-SWIFT"
staticconstexpr

SPARTN-PROP-SWIFT message name.

Definition at line 168 of file spartn.hpp.