sbgECom Library  4.0.1987-stable
C library to interface SBG Systems IMU/AHRS/INS
sbgEComCmdFeatures.h File Reference

Commands used to query supported device features. More...

#include <sbgCommon.h>
#include <sbgECom.h>

Go to the source code of this file.

Data Structures

struct  _SbgEComFeatures
 

Macros

#define SBG_ECOM_SENSOR_FEATURE_IMU   (0x00000001 << 0)
 
#define SBG_ECOM_SENSOR_FEATURE_AHRS   (0x00000001 << 1)
 
#define SBG_ECOM_SENSOR_FEATURE_NAVIGATION   (0x00000001 << 2)
 
#define SBG_ECOM_SENSOR_FEATURE_SHIP_MOTION   (0x00000001 << 3)
 
#define SBG_ECOM_GNSS_SIGNAL_GPS_L1   (0x00000001 << 0)
 
#define SBG_ECOM_GNSS_SIGNAL_GPS_L2   (0x00000001 << 1)
 
#define SBG_ECOM_GNSS_SIGNAL_GPS_L5   (0x00000001 << 2)
 
#define SBG_ECOM_GNSS_SIGNAL_GLONASS_L1   (0x00000001 << 3)
 
#define SBG_ECOM_GNSS_SIGNAL_GLONASS_L2   (0x00000001 << 4)
 
#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B1   (0x00000001 << 5)
 
#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B2   (0x00000001 << 6)
 
#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B3   (0x00000001 << 7)
 
#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E1   (0x00000001 << 8)
 
#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E5   (0x00000001 << 9)
 
#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E6   (0x00000001 << 10)
 
#define SBG_ECOM_GNSS_SIGNAL_QZSS   (0x00000001 << 11)
 
#define SBG_ECOM_GNSS_SIGNAL_SBAS   (0x00000001 << 12)
 
#define SBG_ECOM_GNSS_SIGNAL_L_BAND   (0x00000001 << 13)
 
#define SBG_ECOM_GNSS_FEATURE_DUAL_ANT   (0x00000001 << 0)
 
#define SBG_ECOM_GNSS_FEATURE_RTK_LIMITED   (0x00000001 << 1)
 
#define SBG_ECOM_GNSS_FEATURE_RTK   (0x00000001 << 2)
 
#define SBG_ECOM_GNSS_FEATURE_PPP   (0x00000001 << 3)
 
#define SBG_ECOM_GNSS_FEATURE_RAW_DATA   (0x00000001 << 4)
 
#define SBG_ECOM_GNSS_FEATURE_RAIM   (0x00000001 << 5)
 
#define SBG_ECOM_GNSS_FEATURE_HIGH_SPEED   (0x00000001 << 6)
 

Typedefs

typedef enum _SbgEComGnssType SbgEComGnssType
 
typedef struct _SbgEComFeatures SbgEComFeatures
 

Enumerations

enum  _SbgEComGnssType {
  SBG_ECOM_GNSS_TYPE_DISABLED = 0 ,
  SBG_ECOM_GNSS_TYPE_EXTERNAL = 1 ,
  SBG_ECOM_GNSS_TYPE_UBX_MAX_M8 = 2 ,
  SBG_ECOM_GNSS_TYPE_NOV_OEM615 = 3 ,
  SBG_ECOM_GNSS_TYPE_NOV_OEM615_DUAL = 4 ,
  SBG_ECOM_GNSS_TYPE_NOV_OEM617D = 5 ,
  SBG_ECOM_GNSS_TYPE_SEP_AX4 = 6 ,
  SBG_ECOM_GNSS_TYPE_SEP_AXM2A = 7 ,
  SBG_ECOM_GNSS_TYPE_UBX_F9P = 8
}
 

Functions

SbgErrorCode sbgEComCmdGetFeatures (SbgEComHandle *pHandle, SbgEComFeatures *pFeatures)
 

Detailed Description

Commands used to query supported device features.

Author
SBG Systems
Date
19 March 2015
License

The MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Macro Definition Documentation

◆ SBG_ECOM_SENSOR_FEATURE_IMU

#define SBG_ECOM_SENSOR_FEATURE_IMU   (0x00000001 << 0)

This unit can provide IMU data

◆ SBG_ECOM_SENSOR_FEATURE_AHRS

#define SBG_ECOM_SENSOR_FEATURE_AHRS   (0x00000001 << 1)

This unit can provide orientation data

◆ SBG_ECOM_SENSOR_FEATURE_NAVIGATION

#define SBG_ECOM_SENSOR_FEATURE_NAVIGATION   (0x00000001 << 2)

This unit can provide position and velocity data

◆ SBG_ECOM_SENSOR_FEATURE_SHIP_MOTION

#define SBG_ECOM_SENSOR_FEATURE_SHIP_MOTION   (0x00000001 << 3)

This unit can provide ship motion data output (heave)

◆ SBG_ECOM_GNSS_SIGNAL_GPS_L1

#define SBG_ECOM_GNSS_SIGNAL_GPS_L1   (0x00000001 << 0)

This GNSS receiver tracks GPS L1 band.

◆ SBG_ECOM_GNSS_SIGNAL_GPS_L2

#define SBG_ECOM_GNSS_SIGNAL_GPS_L2   (0x00000001 << 1)

This GNSS receiver tracks GPS L2 band.

◆ SBG_ECOM_GNSS_SIGNAL_GPS_L5

#define SBG_ECOM_GNSS_SIGNAL_GPS_L5   (0x00000001 << 2)

This GNSS receiver tracks GPS L5 band.

◆ SBG_ECOM_GNSS_SIGNAL_GLONASS_L1

#define SBG_ECOM_GNSS_SIGNAL_GLONASS_L1   (0x00000001 << 3)

This GNSS receiver tracks GLONASS L1 band.

◆ SBG_ECOM_GNSS_SIGNAL_GLONASS_L2

#define SBG_ECOM_GNSS_SIGNAL_GLONASS_L2   (0x00000001 << 4)

This GNSS receiver tracks GLONASS L2 band.

◆ SBG_ECOM_GNSS_SIGNAL_BEIDOU_B1

#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B1   (0x00000001 << 5)

This GNSS receiver tracks BEIDOU B1 band.

◆ SBG_ECOM_GNSS_SIGNAL_BEIDOU_B2

#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B2   (0x00000001 << 6)

This GNSS receiver tracks BEIDOU B2 band.

◆ SBG_ECOM_GNSS_SIGNAL_BEIDOU_B3

#define SBG_ECOM_GNSS_SIGNAL_BEIDOU_B3   (0x00000001 << 7)

This GNSS receiver tracks BEIDOU B3 band.

◆ SBG_ECOM_GNSS_SIGNAL_GALILEO_E1

#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E1   (0x00000001 << 8)

This GNSS receiver tracks GALILEO E1 band.

◆ SBG_ECOM_GNSS_SIGNAL_GALILEO_E5

#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E5   (0x00000001 << 9)

This GNSS receiver tracks GALILEO E5 band.

◆ SBG_ECOM_GNSS_SIGNAL_GALILEO_E6

#define SBG_ECOM_GNSS_SIGNAL_GALILEO_E6   (0x00000001 << 10)

This GNSS receiver tracks GALILEO E6 band.

◆ SBG_ECOM_GNSS_SIGNAL_QZSS

#define SBG_ECOM_GNSS_SIGNAL_QZSS   (0x00000001 << 11)

This GNSS receiver tracks QZSS signals

◆ SBG_ECOM_GNSS_SIGNAL_SBAS

#define SBG_ECOM_GNSS_SIGNAL_SBAS   (0x00000001 << 12)

This GNSS receiver tracks SBAS signals

◆ SBG_ECOM_GNSS_SIGNAL_L_BAND

#define SBG_ECOM_GNSS_SIGNAL_L_BAND   (0x00000001 << 13)

This GNSS receiver tracks L-Band (for PPP services)

◆ SBG_ECOM_GNSS_FEATURE_DUAL_ANT

#define SBG_ECOM_GNSS_FEATURE_DUAL_ANT   (0x00000001 << 0)

This GNSS receiver provides a dual antenna heading

◆ SBG_ECOM_GNSS_FEATURE_RTK_LIMITED

#define SBG_ECOM_GNSS_FEATURE_RTK_LIMITED   (0x00000001 << 1)

This GNSS receiver has limited RTK accuracy (eg. Trimble RTK 30/30)

◆ SBG_ECOM_GNSS_FEATURE_RTK

#define SBG_ECOM_GNSS_FEATURE_RTK   (0x00000001 << 2)

This GNSS receiver provides full RTK accuracy

◆ SBG_ECOM_GNSS_FEATURE_PPP

#define SBG_ECOM_GNSS_FEATURE_PPP   (0x00000001 << 3)

This GNSS receiver provides PPP computations

◆ SBG_ECOM_GNSS_FEATURE_RAW_DATA

#define SBG_ECOM_GNSS_FEATURE_RAW_DATA   (0x00000001 << 4)

This GNSS receiver provides RAW data output

◆ SBG_ECOM_GNSS_FEATURE_RAIM

#define SBG_ECOM_GNSS_FEATURE_RAIM   (0x00000001 << 5)

This GNSS receiver provides Receiver Autonomous Integrity Monitoring

◆ SBG_ECOM_GNSS_FEATURE_HIGH_SPEED

#define SBG_ECOM_GNSS_FEATURE_HIGH_SPEED   (0x00000001 << 6)

This GNSS receiver has no high speed limitation (> 515m/s)

Typedef Documentation

◆ SbgEComGnssType

This enum defines the different types of internal GNSS receiver that can provide specific features. Note External type is considered as not handled by the feature system

◆ SbgEComFeatures

This structure contains all the information provided by the SBG_ECOM_CMD_GET_FEATURES command

Enumeration Type Documentation

◆ _SbgEComGnssType

This enum defines the different types of internal GNSS receiver that can provide specific features. Note External type is considered as not handled by the feature system

Enumerator
SBG_ECOM_GNSS_TYPE_DISABLED 

GNSS module disabled

SBG_ECOM_GNSS_TYPE_EXTERNAL 

External GNSS module (all features are unknown)

SBG_ECOM_GNSS_TYPE_UBX_MAX_M8 

Ublox MAX-M8 module

SBG_ECOM_GNSS_TYPE_NOV_OEM615 

Novatel OEM615 device

SBG_ECOM_GNSS_TYPE_NOV_OEM615_DUAL 

Two Novatel OEM615 devices for dual antenna

SBG_ECOM_GNSS_TYPE_NOV_OEM617D 

Novatel OEM617D device

SBG_ECOM_GNSS_TYPE_SEP_AX4 

Septentrio AsteRx-m4

SBG_ECOM_GNSS_TYPE_SEP_AXM2A 

Septentrio AsteRx-m2a

SBG_ECOM_GNSS_TYPE_UBX_F9P 

Ublox ZED-F9P module

Function Documentation

◆ sbgEComCmdGetFeatures()

SbgErrorCode sbgEComCmdGetFeatures ( SbgEComHandle pHandle,
SbgEComFeatures pFeatures 
)

Retrieve the device and embedded GPS receiver features.

Parameters
[in]pHandleA valid sbgECom handle.
[in]pFeaturesA pointer to a structure to hold features.
Returns
SBG_NO_ERROR if the command has been executed successfully.