diff --git a/docs/API_reference/en/gnsslib/quecgnss.md b/docs/API_reference/en/gnsslib/quecgnss.md index 818ceb72601abdf15424417ade4beb7ab59c9125..0f4c9eb9776c52e46d84e084de003ce5a8abbc7b 100644 --- a/docs/API_reference/en/gnsslib/quecgnss.md +++ b/docs/API_reference/en/gnsslib/quecgnss.md @@ -2,7 +2,11 @@ This feature provides the APIs of the built-in GNSS feature. -> Only EC200UCNAA/EC200UCNLA/EC200UEUAA/EC800MCNGA/EC800GCNGA series module supports this feature. +> QuecPython modules list that support built-in GNSS:
+> ECX00U AA/LA series
+> EG91XU AA series
+> EC800M GA/GB/GC/GD series
+> BG95M1/M3 model **Example** diff --git a/docs/API_reference/zh/gnsslib/quecgnss.md b/docs/API_reference/zh/gnsslib/quecgnss.md index 3149502d8315c9b5dd888c4ff4a0bc61fb294188..fd7c1dcb3098709b9290408250274ab12e808a6e 100644 --- a/docs/API_reference/zh/gnsslib/quecgnss.md +++ b/docs/API_reference/zh/gnsslib/quecgnss.md @@ -2,7 +2,13 @@ 此模块提供内置GNSS的使用接口 -> 当前仅 EC200UCNAA/EC200UCNLA/EC200UEUAA/EC800MCNGA/EC800GCNGA/BG95M3 型号支持该功能。 +> QuecPython模组当前内置GNSS支持列表:
+> ECX00U AA/LA系列
+> EG91XU AA系列
+> EC800M GA/GB/GC/GD系列
+> EG810M GA系列
+> EC800G GA系列
+> BG95M1/M3型号 **使用示例** @@ -11,6 +17,9 @@ import quecgnss def main(): + quecgnss.configSet(0,1)#设置定位星系为GPS+Beidou + quecgnss.configSet(2,1)#打开AGPS + quecgnss.configSet(4,1)#打开备电 ret = quecgnss.init() if ret == 0: print('GNSS init ok.') @@ -68,7 +77,6 @@ $GNGLL,3149.324754,N,11706.922338,E,022508.000,A,A*46 $GNGSA,A,3,31,3 ``` - ## GNSS 功能初始化 ### **`quecgnss.init`** @@ -80,7 +88,7 @@ quecgnss.init() 模组内置GNSS模块功能的初始化。 **返回值描述** -成功返回整型`0`,失败返回整型`-1`。 +成功返回整型 `0`,失败返回整型 `-1`。 ## GNSS 工作状态获取 @@ -145,13 +153,14 @@ quecgnss.read(size) ## GNSS/LTE优先级设置 -> 当前仅BG95M3 型号支持该功能。 +> 当前仅BG95M1/M3型号支持该功能。 ### `quecgnss.setPriority` ```python quecgnss.setPriority(Priority) ``` + 在部分模组上,GNSS和LTE会复用射频资源,该接口用来控制GNSS和LTE之间使用射频资源的优先级 **参数描述** @@ -160,7 +169,7 @@ quecgnss.setPriority(Priority) 不同平台GNSS/LTE优先级的对应关系: -| 优先级 | BG95M3 | +| 优先级 | BG95M1/M3 | | ------ | -------- | | 0 | GNSS>LTE | | 1 | LTE>GNSS | @@ -171,7 +180,7 @@ quecgnss.setPriority(Priority) ## GNSS/LTE优先级获取 -> 当前仅BG95M3 型号支持该功能。 +> 当前仅BG95M1/M3型号支持该功能。 ### `quecgnss.getPriority` @@ -187,7 +196,163 @@ quecgnss.getPriority() 不同平台GNSS/LTE优先级的对应关系: -| 优先级 | BG95M3 | +| 优先级 | BG95M1/M3 | | ------ | -------- | | 0 | GNSS>LTE | -| 1 | LTE>GNSS | \ No newline at end of file +| 1 | LTE>GNSS | + +## 内置GNSS配置参数设置 + +> 当前仅EC800M GA/GB/GC/GD系列、EG810M GA系列支持该功能 + +### `quecgnss.configSet` + +```python +quecgnss.configSet(config_type, config_value) +``` + +设置GNSS参数,包括卫星系统、NMEA语句类型、是否使用AGNSS和APFLASH等 + +**参数描述** + +* `config_type`,int,要设置的GNSS配置选项类型,含义如下: + +| 参数 | 类型 | +| ---- | ---------------------- | +| 0 | 配置使用的卫星系统 | +| 1 | 配置输出的NMEA语句类型 | +| 2 | 配置是否使能AGPS | +| 3 | 配置是否使能APFLASH | +| 4 | 配置是否使能GNSS备电 | + +* `config_value`,int,GNSS配置选项的值,含义如下: + +卫星系统(config_type = 0): + +| 参数 | 含义 | +| ---- | ----------------------- | +| 0 | GPS | +| 1 | GPS + BeiDou | +| 3 | GPS + GLONASS + Galileo | +| 4 | GPS + GLONASS | +| 5 | GPS + BeiDou + Galileo | +| 6 | GPS + Galileo | +| 7 | BeiDou | + +NMEA语句类型(config_type = 1):该项以bitmap表示,需要打开的选项置为1 +如需要输出GGA+RMC+GSV+GSA+VTG时,应使用bitmap(011111),换算为十进制为31 + +| 参数 | 含义 | +| ---- | ------------------------ | +| 0 | 禁止输出NMEA语句(000000) | +| 1 | GGA(000001) | +| 2 | RMC(000010) | +| 4 | GSV(000100) | +| 8 | GSA(001000) | +| 16 | VTG(010000) | +| 32 | GLL(100000) | +| 63 | 全部输出(111111) | + +是否使能AGPS(config_type = 2):打开该项时,GNSS会从网络下载星历,并在启动时尝试使用星历加速 + +| 参数 | 含义 | +| ---- | -------- | +| 0 | 关闭AGPS | +| 1 | 打开AGPS | + +是否使能APFLASH(config_type = 3):打开该项时,GNSS会在Quecpython模组保存星历,并在启动时尝试使用星历加速 + +| 参数 | 含义 | +| ---- | ----------- | +| 0 | 关闭APFLASH | +| 1 | 打开APFLASH | + +是否使能备电 (config_type = 4):打开该项并正确连接备电时,GNSS芯片可自行保存星历信息 + +>EC800M GB/GD系列支持备电 + +| 参数 | 含义 | +| ---- | ----------- | +| 0 | 关闭备电 | +| 1 | 打开备电 | + +**返回值描述** + +int,0为成功,否则为失败 + +## 内置GNSS配置参数读取 + +> 当前仅EC800M GA/GB/GC/GD系列、EG810M GA系列支持该功能 + +### `quecgnss.configGet` + +```python +quecgnss.configGet(config_type) +``` + +读取GNSS参数,包括卫星系统、NMEA语句类型、是否使用AGNSS和APFLASH等 + +**参数描述** + +* `config_type`,int,要读取的GNSS配置选项类型,含义如下: + +| 参数 | 类型 | +| ---- | ---------------------- | +| 0 | 配置使用的卫星系统 | +| 1 | 配置输出的NMEA语句类型 | +| 2 | 配置是否使能AGPS | +| 3 | 配置是否使能APFLASH | +| 4 | 配置是否使能GNSS备电 | + +**返回值描述** + +int,含义如下(-1为失败) + +卫星系统(config_type = 0): + +| 参数 | 含义 | +| ---- | ----------------------- | +| 0 | GPS | +| 1 | GPS + BeiDou | +| 3 | GPS + GLONASS + Galileo | +| 4 | GPS + GLONASS | +| 5 | GPS + BeiDou + Galileo | +| 6 | GPS + Galileo | +| 7 | BeiDou | + +NMEA语句类型(config_type = 1):该项以bitmap表示,被打开的选项置为1 +如输出GGA+RMC+GSV+GSA+VTG时,返回的值为31,换算为二进制即为bitmap(011111) + +| 参数 | 含义 | +| ---- | ------------------------ | +| 0 | 禁止输出NMEA语句(000000) | +| 1 | GGA(000001) | +| 2 | RMC(000010) | +| 4 | GSV(000100) | +| 8 | GSA(001000) | +| 16 | VTG(010000) | +| 32 | GLL(100000) | +| 63 | 全部输出(111111) | + +是否使能AGPS(config_type = 2):打开该项时,GNSS会从网络下载星历,并在启动时尝试使用星历加速 + +| 参数 | 含义 | +| ---- | -------- | +| 0 | 关闭AGPS | +| 1 | 打开AGPS | + +是否使能APFLASH(config_type = 3):打开该项时,GNSS会在Quecpython模组保存星历,并在启动时尝试使用星历加速 + +| 参数 | 含义 | +| ---- | ----------- | +| 0 | 关闭APFLASH | +| 1 | 打开APFLASH | + +是否使能备电 (config_type = 4):打开该项并正确连接备电时,GNSS芯片可自行保存星历信息 + +>EC800M GB/GD系列支持备电 + +| 参数 | 含义 | +| ---- | ----------- | +| 0 | 关闭备电 | +| 1 | 打开备电 | \ No newline at end of file