Skip to content

增加内置GNSS模块接口说明 #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
guozhenh merged 2 commits into from
Apr 6, 2022
Merged

增加内置GNSS模块接口说明 #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18e814f
增加内置GNSS模块接口说明
Apr 6, 2022
b3871ba
Merge branch 'main' of https://github.com/Mr-FJC/wiki
Apr 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 161 additions & 6 deletions en-us/api/QuecPythonClasslib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4718,10 +4718,6 @@ The values returned are explained as follows:
| 8 | Booting from PSM wakeup |
| 9 | Booting by dump |

* Note

* BC25PA platform does not support restart reason 5 and 6.



###### Get the Reason for the Last Powering Down of the Module
Expand Down Expand Up @@ -10976,7 +10972,7 @@ camCaputre.callback(callback)



#### GNSS - Navigation Positioning and Timing
#### GNSS - External GNSS

Module function: Get positioning data from GPS model of L76 module, including whether the module locates successfully, latitude, longitude, UTC time, positioning mode, number of satellites, number of visible satellites, azimuth angle, speed over the ground, geodetic height and so on.

Expand Down Expand Up @@ -11065,7 +11061,7 @@ total_sen_num = 3, total_sat_num = 12 # Output the total number of complete GPG



##### Get the original GNSS data read
##### Get the original GNSS data

> **gnss.getOriginalData()**

Expand Down Expand Up @@ -11336,6 +11332,165 @@ gnss.getSpeed()





#### quecgnss - built-in GNSS

Note: The current only EC200UCNAA/EC200UCNLA/EC200UEUAA models support this feature.

##### Initialize the GNSS

> **import quecgnss**
>
> **quecgnss.init()**

* Function

Initialization of GNSS module functions.

* Parameter

None

* Return Value

Returns integer 0 on success, integer -1 on failure.



##### Get the GNSS working status

> **quecgnss.get_state()**

* Function

Get the GNSS module status.

* Parameter

None

* Return Value

| Value | Type | Description |
| ----- | ---- | ------------------------------------------------------------ |
| 0 | int | The GNSS module is closed |
| 1 | int | The GNSS module is being firmware upgrade |
| 2 | int | The GNSS module is positioning. In this mode, the GNSS module starts to read GNSS positioning data. The validity of the positioning data needs to be determined by parsing corresponding statements after obtaining the positioning data, for example, whether the STATUS of the GNRMC statement is A or V. A indicates that the positioning is valid, and V indicates that the positioning is invalid. |



##### Enable or disable GNSS

> **quecgnss.gnssEnable(opt)**

* Function

Enable or disable the GNSS module. If you use the GNSS function for the first time after power-on, you do not need to invoke this interface to enable the GNSS function. Instead, you can invoke the init() interface. The init() interface automatically enables the GNSS function during initialization.

* Parameter

| Parameter | Type | Description |
| --------- | ---- | ------------------------------------ |
| opt | int | 0 - disable GNSS<br/>1 - enable GNSS |

* Return Value

Returns integer 0 on success, integer -1 on failure.



##### Get the GNSS data

> **quecgnss.read(size)**

* Function

Get the GNSS data。

* Parameter

| Parameter | Type | Description |
| --------- | ---- | ---------------------------------------------------------- |
| size | int | Specifies the size of the data to read, the unit is bytes. |

* Return Value

Returns a tuple on success, integer -1 on failure. The tuple form is as follows:

`(size, data)`

`size` - The actual size of the data read

`data` - positioning data

##### Example

```python
import quecgnss


def main():
ret = quecgnss.init()
if ret == 0:
print('GNSS init ok.')
else:
print('GNSS init failed.')
return -1
data = quecgnss.read(4096)
print(data[1].decode())

quecgnss.gnssEnable(0)


if __name__ == '__main__':
main()


#===================================================================================================
# The result
167,169,170,,,,,,,,1.773,1.013,1.455*15
$GPGSV,2,1,8,3,23,303,34,16,32,219,28,22,74,98,26,25,16,43,25*77
$GPGSV,2,2,8,26,70,236,28,31,59,12,38,32,55,127,34,4,5,,21*49
$BDGSV,2,1,8,163,51,192,32,166,70,11,31,167,52,197,32,169,59,334,31*61
$BDGSV,2,2,8,170,40,205,31,161,5,,31,164,5,,27,165,5,,29*59
$GNRMC,022326.000,A,3149.324624,N,11706.921702,E,0.000,261.541,180222,,E,A*38
$GNGGA,022326.000,3149.324624,N,11706.921702,E,1,12,1.013,-8.580,M,0,M,,*47
$GNGLL,3149.324624,N,11706.921702,E,022326.000,A,A*44
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.773,1.013,1.455*1C
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.773,1.013,1.455*15
$GPGSV,2,1,8,3,23,303,34,16,32,219,27,22,74,98,26,25,16,43,25*78
$GPGSV,2,2,8,26,70,236,28,31,59,12,37,32,55,127,34,4,5,,20*47
$BDGSV,2,1,8,163,51,192,32,166,70,11,31,167,52,197,32,169,59,334,31*61
$BDGSV,2,2,8,170,40,205,31,161,5,,31,164,5,,27,165,5,,29*59
$GNRMC,022327.000,A,3149.324611,N,11706.921713,E,0.000,261.541,180222,,E,A*3F
$GNGGA,022327.000,3149.324611,N,11706.921713,E,1,12,1.013,-8.577,M,0,M,,*48
$GNGLL,3149.324611,N,11706.921713,E,022327.000,A,A*43
...... # There is too much data, so it is omitted
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.837,1.120,1.456*11
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.837,1.120,1.456*18
$GPGSV,2,1,8,3,23,302,27,16,32,220,26,22,73,101,27,25,16,43,27*45
$GPGSV,2,2,8,26,70,237,28,31,59,13,33,32,54,128,28,4,5,,24*44
$BDGSV,2,1,8,163,51,192,33,166,71,11,35,167,52,198,33,169,59,334,34*6E
$BDGSV,2,2,8,170,40,205,32,161,5,,33,164,5,,28,165,5,,30*5F
$GNRMC,022507.000,A,3149.324768,N,11706.922344,E,0.000,261.541,180222,,E,A*31
$GNGGA,022507.000,3149.324768,N,11706.922344,E,1,12,1.120,-8.794,M,0,M,,*48
$GNGLL,3149.324768,N,11706.922344,E,022507.000,A,A*4D
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.837,1.120,1.455*12
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.837,1.120,1.455*1B
$GPGSV,2,1,8,3,23,302,26,16,32,220,26,22,73,101,27,25,16,43,26*45
$GPGSV,2,2,8,26,70,237,28,31,59,13,32,32,54,128,28,4,5,,24*45
$BDGSV,2,1,8,163,51,192,24,166,71,11,35,167,52,198,33,169,59,334,34*68
$BDGSV,2,2,8,170,40,205,31,161,5,,33,164,5,,28,165,5,,30*5C
$GNRMC,022508.000,A,3149.324754,N,11706.922338,E,0.002,261.541,180222,,E,A*38
$GNGGA,022508.000,3149.324754,N,11706.922338,E,1,12,1.120,-8.750,M,0,M,,*4B
$GNGLL,3149.324754,N,11706.922338,E,022508.000,A,A*46
$GNGSA,A,3,31,3

```



#### Securedata - secure data area

Module function: the module provides a bare flash area and a special read-write interface for customers to store important information, and the information will not be lost after burning the firmware (burning the firmware without this function cannot be guaranteed not to be lost). Provide a storage and read interface, not a delete interface.
Expand Down
163 changes: 158 additions & 5 deletions zh-cn/api/QuecPythonClasslib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4815,10 +4815,6 @@ while 1:
| 8 | PSM 唤醒开机 |
| 9 | 发生 Dump 后重启 |

* 注意

BC25PA平台不支持重启原因5、6。



###### 获取模块上次关机原因
Expand Down Expand Up @@ -10983,7 +10979,7 @@ camCaputre.callback(callback)



#### GNSS - 定位授时
#### GNSS - 外置GNSS

模块功能：对L76K GPS型号进行数据获取，可以得到模块定位是否成功，定位的经纬度数据，UTC授时时间，获取GPS模块的定位模式，获取GPS模块定位使用卫星数量，获取GPS模块定位可见卫星数量，获取定位方位角，GPS模块对地速度，模块定位大地高等数据信息。目前，该模块提供的功能接口，所获取的数据都来源于从串口读出的原始GNSS数据包中的GNGGA、GNRMC和GPGSV语句。

Expand Down Expand Up @@ -11350,6 +11346,163 @@ gnss.getSpeed()



#### quecgnss - 内置GNSS

说明：当前仅 EC200UCNAA/EC200UCNLA/EC200UEUAA 型号支持该功能。

##### GNSS 功能初始化

> **import quecgnss**
>
> **quecgnss.init()**

* 功能

模组内置GNSS模块功能的初始化。

* 参数

无

* 返回值

成功返回整形0，失败返回整形-1。



##### GNSS 工作状态获取

> **quecgnss.get_state()**

* 功能

获取GNSS模块当前工作状态

* 参数

无

* 返回值

| 返回值 | 类型 | 说明 |
| ------ | ---- | ------------------------------------------------------------ |
| 0 | int | GNSS模块处于关闭状态 |
| 1 | int | GNSS模块固件升级中 |
| 2 | int | GNSS模块定位中，这种模式下即可开始读取GNSS定位数据，定位数据是否有效需要用户获取到定位数据后，解析对应语句来判断，比如判断GNRMC语句的status是 A 还是 V，A 表示定位有效，V 表示定位无效。 |



##### GNSS开关

> **quecgnss.gnssEnable(opt)**

* 功能

开启或者关闭GNSS模块。如果是上电后第一次使用内置GNSS功能，一般不需要调用该接口来开启GNSS功能，直接调用init()接口即可，init() 接口在初始化时会自动开启GNSS功能。

* 参数

| 参数 | 类型 | 说明 |
| ---- | ---- | ------------------------------------- |
| opt | int | 0 - 关闭GNSS功能<br/>1 - 开启GNSS功能 |

* 返回值

成功返回整形0，失败返回整形-1。



##### GNSS定位数据获取

> **quecgnss.read(size)**

* 功能

读取GNSS定位数据。

* 参数

| 参数 | 类型 | 说明 |
| ---- | ---- | ------------------------------ |
| size | int | 指定读取数据的大小，单位字节。 |

* 返回值

成功返回一个元组，失败返回整形-1。元组形式如下：

`(size, data)`

`size` - 实际读取数据的大小

`data` - GNSS定位数据

##### GNSS使用示例

```python
import quecgnss


def main():
ret = quecgnss.init()
if ret == 0:
print('GNSS init ok.')
else:
print('GNSS init failed.')
return -1
data = quecgnss.read(4096)
print(data[1].decode())

quecgnss.gnssEnable(0)


if __name__ == '__main__':
main()


#===================================================================================================
#运行结果
167,169,170,,,,,,,,1.773,1.013,1.455*15
$GPGSV,2,1,8,3,23,303,34,16,32,219,28,22,74,98,26,25,16,43,25*77
$GPGSV,2,2,8,26,70,236,28,31,59,12,38,32,55,127,34,4,5,,21*49
$BDGSV,2,1,8,163,51,192,32,166,70,11,31,167,52,197,32,169,59,334,31*61
$BDGSV,2,2,8,170,40,205,31,161,5,,31,164,5,,27,165,5,,29*59
$GNRMC,022326.000,A,3149.324624,N,11706.921702,E,0.000,261.541,180222,,E,A*38
$GNGGA,022326.000,3149.324624,N,11706.921702,E,1,12,1.013,-8.580,M,0,M,,*47
$GNGLL,3149.324624,N,11706.921702,E,022326.000,A,A*44
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.773,1.013,1.455*1C
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.773,1.013,1.455*15
$GPGSV,2,1,8,3,23,303,34,16,32,219,27,22,74,98,26,25,16,43,25*78
$GPGSV,2,2,8,26,70,236,28,31,59,12,37,32,55,127,34,4,5,,20*47
$BDGSV,2,1,8,163,51,192,32,166,70,11,31,167,52,197,32,169,59,334,31*61
$BDGSV,2,2,8,170,40,205,31,161,5,,31,164,5,,27,165,5,,29*59
$GNRMC,022327.000,A,3149.324611,N,11706.921713,E,0.000,261.541,180222,,E,A*3F
$GNGGA,022327.000,3149.324611,N,11706.921713,E,1,12,1.013,-8.577,M,0,M,,*48
$GNGLL,3149.324611,N,11706.921713,E,022327.000,A,A*43
...... # 数据较多，省略
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.837,1.120,1.456*11
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.837,1.120,1.456*18
$GPGSV,2,1,8,3,23,302,27,16,32,220,26,22,73,101,27,25,16,43,27*45
$GPGSV,2,2,8,26,70,237,28,31,59,13,33,32,54,128,28,4,5,,24*44
$BDGSV,2,1,8,163,51,192,33,166,71,11,35,167,52,198,33,169,59,334,34*6E
$BDGSV,2,2,8,170,40,205,32,161,5,,33,164,5,,28,165,5,,30*5F
$GNRMC,022507.000,A,3149.324768,N,11706.922344,E,0.000,261.541,180222,,E,A*31
$GNGGA,022507.000,3149.324768,N,11706.922344,E,1,12,1.120,-8.794,M,0,M,,*48
$GNGLL,3149.324768,N,11706.922344,E,022507.000,A,A*4D
$GNGSA,A,3,31,32,3,16,22,25,26,,,,,,1.837,1.120,1.455*12
$GNGSA,A,3,163,166,167,169,170,,,,,,,,1.837,1.120,1.455*1B
$GPGSV,2,1,8,3,23,302,26,16,32,220,26,22,73,101,27,25,16,43,26*45
$GPGSV,2,2,8,26,70,237,28,31,59,13,32,32,54,128,28,4,5,,24*45
$BDGSV,2,1,8,163,51,192,24,166,71,11,35,167,52,198,33,169,59,334,34*68
$BDGSV,2,2,8,170,40,205,31,161,5,,33,164,5,,28,165,5,,30*5C
$GNRMC,022508.000,A,3149.324754,N,11706.922338,E,0.002,261.541,180222,,E,A*38
$GNGGA,022508.000,3149.324754,N,11706.922338,E,1,12,1.120,-8.750,M,0,M,,*4B
$GNGLL,3149.324754,N,11706.922338,E,022508.000,A,A*46
$GNGSA,A,3,31,3

```



#### SecureData - 安全数据区

模块功能：模组提供一块裸flash区域及专门的读写接口供客户存贮重要信息，且信息在烧录固件后不丢失(烧录不包含此功能的固件无法保证不丢失)。提供一个存储和读取接口，不提供删除接口。
Expand Down