Reference
文档聚焦GNSS module API,涵盖getUTC/getDate时间日期接口、getLat/getLon经纬度解析、getAlt/getHdop精度信息、差分GPS参数,以及setModule切换4G/Lora、波特率配置与getGnssMessage数据获取,为从Docs → Tutorials → Projects → GNSS SKU → 通信与定位Category的学习路径提供基础接口说明。
API Description
/**
* @fn getUTC
* @brief Get UTC, standard time
* @return sTim_t type, represents the returned hour, minute and second
* @retval sTim_t.hour hour
* @retval sTim_t.minute minute
* @retval sTim_t.second second
*/
sTim_t getUTC(void);
/**
* @fn getDate
* @brief Get date information, year, month, day
* @return sTim_t type, represents the returned year, month, day
* @retval sTim_t.year year
* @retval sTim_t.month month
* @retval sTim_t.day day
*/
sTim_t getDate(void);
/**
* @fn getLat
* @brief Get latitude
* @return sLonLat_t type, represents the returned latitude
* @retval sLonLat_t.latDD Latitude degree(0-90)
* @retval sLonLat_t.latMM The first and second digits behind the decimal point
* @retval sLonLat_t.latMMMMM Latitude The third and seventh digits behind the decimal point
* @retval sLonLat_t.latitude Latitude value with 7 decimal digits
* @retval sLonLat_t.latDirection Direction of latitude
*/
sLonLat_t getLat(void);
/**
* @fn getLon
* @brief Get longitude
* @return sLonLat_t Type, represents the returned longitude
* @retval sLonLat_t.lonDDD Longitude degree(0-90)
* @retval sLonLat_t.lonMM Longitude The first and second digits behind the decimal point
* @retval sLonLat_t.lonMMMMM Longitude The third and seventh digits behind the decimal point
* @retval sLonLat_t.lonitude Longitude value with 7 decimal digits
* @retval sLonLat_t.lonDirection Direction of longitude
*/
sLonLat_t getLon(void);
/**
* @fn getNumSatUsed
* @brief Get the number of the used satellite used
* @return uint8_t type, represents the number of the used satellite
*/
uint8_t getNumSatUsed(void);
/**
* @fn getAlt
* @brief Altitude information
* @return double type, represents altitude
*/
double getAlt(void);
/**
* @fn getSep
* @brief At the height of geoid
* @return double
*/
double getSep(void);
/**
* @fn getHdop
* @brief Indicates the horizontal accuracy of positioning
* @return double
*/
double getHdop(void);
/**
* @fn getQuality
* @brief message Quality
* @return uint8_t
*/
uint8_t getQuality(void);
/**
* @fn getSiteID
* @brief The site id of differential gps data, commonly used for differential gps positioning
* @return uint16_t
*/
uint16_t getSiteID(void);
/**
* @fn getDifTime
* @brief The number of seconds in which a differential signal was last received
* @return double
*/
double getDifTime(void);
/**
* @fn setModule
* @brief Set the Module
* @param mode 4G or lora
*/
void setModule(eModuleMode_t mode);
/**
* @fn getModule
* @brief Get the Module run mode
* @return eModuleMode_t
*/
eModuleMode_t getModule(void);
/**
* @fn transmitAT
* @brief Interface for transparent transmission of gnss commands
* @return char * return commands
*/
char * transmitAT(const char* cmd);
/**
* @fn getGnssMessage
* @brief Get different types of gps data
* @param mode eGnssData_t type
* @return char*
*/
char * getGnssMessage(eGnssData_t mode);
/**
* @fn getAllGnss
* @brief Get GNSS data, call back and receive
* @return null
*/
void getAllGnss(void);
/**
* @fn setModuleBaud
* @brief Set the Module Baud rate
* @param baud eModuleBaud_t
*/
void setModuleBaud(eModuleBaud_t baud);
/**
* @fn setLoraBaud
* @brief Set the recevie Lora Baud rate
* @param baud eModuleBaud_t
*/
void setLoraBaud(eModuleBaud_t baud);
/**
* @fn getModuleBaud
* @brief Get the Module Baud rate
* @return uint32_t Baud rate of serial communication
*/
uint32_t getModuleBaud(void);
/**
* @fn getLoraBaud
* @brief Get the Lora Baud rate
* @return uint32_t Baud rate of serial communication
*/
uint32_t getLoraBaud(void);
/**
* @fn setCallback
* @brief Set callback function type
* @param call function name
* @return null
*/
void setCallback(void (*call)(char *, uint8_t));
GNSS Protocol Specification
Was this article helpful?
