Developer World
Spresense Arduino Library v1.4.2-7e8b4bd
SpNavData Class Reference

GNSS positioning data. More...

#include <GNSS.h>

Collaboration diagram for SpNavData:

Public Member Functions

int isSatelliteType (unsigned long index, SpSatelliteType sattype)
 Check if the specified satellite is GPS. More...
 
int isSatelliteTypeGps (unsigned long index)
 [Obsolete] Check if the specified satellite is GPS More...
 
int isSatelliteTypeGlonass (unsigned long index)
 [Obsolete] Check if the specified satellite is Glonass More...
 
SpSatelliteType getSatelliteType (unsigned long index)
 Get satellite type. More...
 
unsigned char getSatelliteId (unsigned long index)
 Get satellite ID(SVID) More...
 
unsigned char getSatelliteElevation (unsigned long index)
 Get satellite elevation. More...
 
unsigned char getSatelliteAzimuth (unsigned long index)
 Get satellite azimuth. More...
 
float getSatelliteSignalLevel (unsigned long index)
 Get satellite signal level(C/N) More...
 

Public Attributes

SpGnssTime time
 
unsigned char type
 
unsigned char numSatellites
 
unsigned char posFixMode
 
unsigned char posDataExist
 
unsigned char numSatellitesCalcPos
 
unsigned short satelliteType
 
unsigned short posSatelliteType
 
double latitude
 
double longitude
 
double altitude
 
float velocity
 
float direction
 
float pdop
 
float hdop
 
float vdop
 
float tdop
 
SpSatellite satellite [24]
 

Detailed Description

GNSS positioning data.

Store the positioning result in this object.

Member Function Documentation

◆ isSatelliteType()

int SpNavData::isSatelliteType ( unsigned long  index,
SpSatelliteType  sattype 
)

Check if the specified satellite is GPS.

If the satellite of the element of array index is GPS, 1 is returned.

Parameters
[in]indexArray number of the satellite array
[in]sattypeType of satellite system
Returns
1 match, 0 unmatch

◆ isSatelliteTypeGps()

int SpNavData::isSatelliteTypeGps ( unsigned long  index)
inline

[Obsolete] Check if the specified satellite is GPS

This function is obsolete. Replace with isSatelliteType.

◆ isSatelliteTypeGlonass()

int SpNavData::isSatelliteTypeGlonass ( unsigned long  index)
inline

[Obsolete] Check if the specified satellite is Glonass

This function is obsolete. Replace with isSatelliteType.

◆ getSatelliteType()

SpSatelliteType SpNavData::getSatelliteType ( unsigned long  index)

Get satellite type.

Specify the element number of the satellite and return the type of satellite system.

Parameters
[in]indexArray number of the satellite array
Returns
Type of satellite system

◆ getSatelliteId()

unsigned char SpNavData::getSatelliteId ( unsigned long  index)

Get satellite ID(SVID)

Specify the element number of the satellite and return the SatelliteId value stored in the array.

Parameters
[in]indexArray number of the satellite array
Returns
Value of array SatelliteId

◆ getSatelliteElevation()

unsigned char SpNavData::getSatelliteElevation ( unsigned long  index)

Get satellite elevation.

Specify the element number of the satellite and return the SatelliteElevation value stored in the array.

Parameters
[in]indexArray number of the satellite array
Returns
Value of array SatelliteElevation

◆ getSatelliteAzimuth()

unsigned char SpNavData::getSatelliteAzimuth ( unsigned long  index)

Get satellite azimuth.

Specify the element number of the satellite and return the SatelliteAzimuth value stored in the array.

Parameters
[in]indexArray number of the satellite array
Returns
Value of array SatelliteAzimuth

◆ getSatelliteSignalLevel()

float SpNavData::getSatelliteSignalLevel ( unsigned long  index)

Get satellite signal level(C/N)

Specify the element number of the satellite and return the SignalLevel value stored in the array.

Parameters
[in]indexArray number of the satellite array
Returns
Value of array SatelliteSignalLevel

Member Data Documentation

◆ time

SpGnssTime SpNavData::time

Time when this position data was updated

◆ type

unsigned char SpNavData::type

Position type; 0:Invalid, 1:GNSS, 2:reserv, 3:user set, 4:previous

◆ numSatellites

unsigned char SpNavData::numSatellites

Number of visible satellites

◆ posFixMode

unsigned char SpNavData::posFixMode

FIX mode, 0:Invalid, 1:2D FIX, 2:3D FIX

◆ posDataExist

unsigned char SpNavData::posDataExist

Is position data existed, 0:none, 1:exist

◆ numSatellitesCalcPos

unsigned char SpNavData::numSatellitesCalcPos

Number of satellites to calculate the position

◆ satelliteType

unsigned short SpNavData::satelliteType

using sv system, bit field; bit0:GPS, bit1:GLONASS

◆ posSatelliteType

unsigned short SpNavData::posSatelliteType

using sv system, bit field; bit0:GPS, bit1:GLONASS

◆ latitude

double SpNavData::latitude

Latitude [degree]

◆ longitude

double SpNavData::longitude

Longitude [degree]

◆ altitude

double SpNavData::altitude

Altitude [meter]

◆ velocity

float SpNavData::velocity

Velocity [m/s]

◆ direction

float SpNavData::direction

Direction [degree]

◆ pdop

float SpNavData::pdop

Position DOP [-]

◆ hdop

float SpNavData::hdop

Horizontal DOP [-]

◆ vdop

float SpNavData::vdop

Vertical DOP [-]

◆ tdop

float SpNavData::tdop

Time DOP [-]

◆ satellite

SpSatellite SpNavData::satellite[24]

satellite data array


The documentation for this class was generated from the following file: